iot_security_solution

Creates, updates, deletes, gets or lists an iot_security_solution resource.

Overview

Name	iot_security_solution
Type	Resource
Id	azure.security.iot_security_solution

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalWorkspaces	array	List of additional workspaces.
autoDiscoveredResources	array	List of resources that were automatically discovered as relevant to the security solution.
disabledDataSources	array	Disabled data sources. Disabling these data sources compromises the system.
displayName	string	Resource display name. Required.
export	array	List of additional options for exporting to workspace data.
iotHubs	array	IoT Hub resource IDs. Required.
location	string	The geo-location where the resource lives.
recommendationsConfiguration	array	List of the configuration status for each recommendation type.
status	string	Status of the IoT Security solution. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
unmaskedIpLoggingStatus	string	Unmasked IP address logging status. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
userDefinedResources	object	Properties of the IoT Security solution's user defined resources.
workspace	string	Workspace resource ID.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalWorkspaces	array	List of additional workspaces.
autoDiscoveredResources	array	List of resources that were automatically discovered as relevant to the security solution.
disabledDataSources	array	Disabled data sources. Disabling these data sources compromises the system.
displayName	string	Resource display name. Required.
export	array	List of additional options for exporting to workspace data.
iotHubs	array	IoT Hub resource IDs. Required.
location	string	The geo-location where the resource lives.
recommendationsConfiguration	array	List of the configuration status for each recommendation type.
status	string	Status of the IoT Security solution. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
unmaskedIpLoggingStatus	string	Unmasked IP address logging status. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
userDefinedResources	object	Properties of the IoT Security solution's user defined resources.
workspace	string	Workspace resource ID.

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalWorkspaces	array	List of additional workspaces.
autoDiscoveredResources	array	List of resources that were automatically discovered as relevant to the security solution.
disabledDataSources	array	Disabled data sources. Disabling these data sources compromises the system.
displayName	string	Resource display name. Required.
export	array	List of additional options for exporting to workspace data.
iotHubs	array	IoT Hub resource IDs. Required.
location	string	The geo-location where the resource lives.
recommendationsConfiguration	array	List of the configuration status for each recommendation type.
status	string	Status of the IoT Security solution. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
unmaskedIpLoggingStatus	string	Unmasked IP address logging status. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
userDefinedResources	object	Properties of the IoT Security solution's user defined resources.
workspace	string	Workspace resource ID.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, solution_name, subscription_id		User this method to get details of a specific IoT Security solution based on solution name.
list_by_resource_group	select	resource_group_name, subscription_id	$filter	Use this method to get the list IoT Security solutions organized by resource group.
list_by_subscription	select	subscription_id	$filter	Use this method to get the list of IoT Security solutions by subscription.
create_or_update	insert	resource_group_name, solution_name, subscription_id		Use this method to create or update yours IoT Security solution.
update	update	resource_group_name, solution_name, subscription_id		Use this method to update existing IoT Security solution tags or user defined resources. To update other fields use the CreateOrUpdate method.
create_or_update	replace	resource_group_name, solution_name, subscription_id		Use this method to create or update yours IoT Security solution.
delete	delete	resource_group_name, solution_name, subscription_id		Use this method to delete yours IoT Security solution.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
solution_name	string	The name of the IoT Security solution. Required.
subscription_id	string
$filter	string	Filter the IoT Security solution with OData syntax. Supports filtering by iotHubs. Default value is None.

SELECT examples

get

User this method to get details of a specific IoT Security solution based on solution name.

SELECT
id,
name,
additionalWorkspaces,
autoDiscoveredResources,
disabledDataSources,
displayName,
export,
iotHubs,
location,
recommendationsConfiguration,
status,
systemData,
tags,
type,
unmaskedIpLoggingStatus,
userDefinedResources,
workspace
FROM azure.security.iot_security_solution
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND solution_name = '{{ solution_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Use this method to get the list IoT Security solutions organized by resource group.

SELECT
id,
name,
additionalWorkspaces,
autoDiscoveredResources,
disabledDataSources,
displayName,
export,
iotHubs,
location,
recommendationsConfiguration,
status,
systemData,
tags,
type,
unmaskedIpLoggingStatus,
userDefinedResources,
workspace
FROM azure.security.iot_security_solution
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

list_by_subscription

Use this method to get the list of IoT Security solutions by subscription.

SELECT
id,
name,
additionalWorkspaces,
autoDiscoveredResources,
disabledDataSources,
displayName,
export,
iotHubs,
location,
recommendationsConfiguration,
status,
systemData,
tags,
type,
unmaskedIpLoggingStatus,
userDefinedResources,
workspace
FROM azure.security.iot_security_solution
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
;

INSERT examples

create_or_update

Use this method to create or update yours IoT Security solution.

INSERT INTO azure.security.iot_security_solution (
properties,
tags,
location,
resource_group_name,
solution_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ resource_group_name }}',
'{{ solution_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: iot_security_solution
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the iot_security_solution resource.
  - name: solution_name
    value: "{{ solution_name }}"
    description: Required parameter for the iot_security_solution resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the iot_security_solution resource.
  - name: properties
    description: |
      Security Solution data.
    value:
      workspace: "{{ workspace }}"
      displayName: "{{ displayName }}"
      status: "{{ status }}"
      export:
        - "{{ export }}"
      disabledDataSources:
        - "{{ disabledDataSources }}"
      iotHubs:
        - "{{ iotHubs }}"
      userDefinedResources:
        query: "{{ query }}"
        querySubscriptions:
          - "{{ querySubscriptions }}"
      autoDiscoveredResources:
        - "{{ autoDiscoveredResources }}"
      recommendationsConfiguration:
        - recommendationType: "{{ recommendationType }}"
          name: "{{ name }}"
          status: "{{ status }}"
      unmaskedIpLoggingStatus: "{{ unmaskedIpLoggingStatus }}"
      additionalWorkspaces:
        - workspace: "{{ workspace }}"
          type: "{{ type }}"
          dataTypes: "{{ dataTypes }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives.

UPDATE examples

update

Use this method to update existing IoT Security solution tags or user defined resources. To update other fields use the CreateOrUpdate method.

UPDATE azure.security.iot_security_solution
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND solution_name = '{{ solution_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Use this method to create or update yours IoT Security solution.

REPLACE azure.security.iot_security_solution
SET 
properties = '{{ properties }}',
tags = '{{ tags }}',
location = '{{ location }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND solution_name = '{{ solution_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Use this method to delete yours IoT Security solution.

DELETE FROM azure.security.iot_security_solution
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND solution_name = '{{ solution_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;