iot_security_solutions

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

Overview

Name	iot_security_solutions
Type	Resource
Id	azure.security.iot_security_solutions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
location	string	The resource location.
properties	object	Security Solution data
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"

list_by_resource_group

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
location	string	The resource location.
properties	object	Security Solution data
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"

list_by_subscription

Name	Datatype	Description
id	string (arm-id)	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	The name of the resource
location	string	The resource location.
properties	object	Security Solution data
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"

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, solutionName	api-version	User this method to get details of a specific IoT Security solution based on solution name
list_by_resource_group	select	subscriptionId, resourceGroupName	api-version, $filter	Use this method to get the list IoT Security solutions organized by resource group.
list_by_subscription	select	subscriptionId	api-version, $filter	Use this method to get the list of IoT Security solutions by subscription.
create_or_update	insert	subscriptionId, resourceGroupName, solutionName	api-version	Use this method to create or update yours IoT Security solution
update	update	subscriptionId, resourceGroupName, solutionName	api-version	Use this method to update existing IoT Security solution tags or user defined resources. To update other fields use the CreateOrUpdate method.
delete	delete	subscriptionId, resourceGroupName, solutionName	api-version	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
resourceGroupName	string	The name of the resource group within the user's subscription. The name is case insensitive.
solutionName	string	The name of the IoT Security solution.
subscriptionId	string	Azure subscription ID
$filter	string	Filter the IoT Security solution with OData syntax. Supports filtering by iotHubs.
api-version	string	API version for the operation

SELECT examples

get

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

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.security.iot_security_solutions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND solutionName = '{{ solutionName }}' -- required
AND api-version = '{{ api-version }}'
;

list_by_resource_group

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

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.security.iot_security_solutions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND api-version = '{{ api-version }}'
AND $filter = '{{ $filter }}'
;

list_by_subscription

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

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.security.iot_security_solutions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND api-version = '{{ api-version }}'
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_solutions (
data__location,
data__properties,
data__tags,
subscriptionId,
resourceGroupName,
solutionName,
api-version
)
SELECT 
'{{ location }}',
'{{ properties }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ solutionName }}',
'{{ api-version }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: iot_security_solutions
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the iot_security_solutions resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the iot_security_solutions resource.
    - name: solutionName
      value: string
      description: Required parameter for the iot_security_solutions resource.
    - name: location
      value: string
      description: |
        The resource location.
    - name: properties
      value: object
      description: |
        Security Solution data
    - name: tags
      value: object
      description: |
        Resource tags
    - name: api-version
      value: string
      description: API version for the operation

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_solutions
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND solutionName = '{{ solutionName }}' --required
AND api-version = '{{ api-version}}'
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_solutions
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND solutionName = '{{ solutionName }}' --required
AND api-version = '{{ api-version }}'
;