device_security_groups

Creates, updates, deletes, gets or lists a device_security_groups resource.

Overview

Name	device_security_groups
Type	Resource
Id	azure.security.device_security_groups

Fields

The following fields are returned by SELECT queries:

get

Successful request to get device security 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
properties	object	Device Security group data
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

list

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
properties	object	Device Security group data
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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	deviceSecurityGroupName	api-version, resourceId	Use this method to get the device security group for the specified IoT Hub resource.
list	select		api-version, resourceId	Use this method get the list of device security groups for the specified IoT Hub resource.
create_or_update	insert	deviceSecurityGroupName	api-version, resourceId	Use this method to creates or updates the device security group on a specified IoT Hub resource.
delete	delete	deviceSecurityGroupName	api-version, resourceId	User this method to deletes the device security group.

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
deviceSecurityGroupName	string	The name of the device security group. Note that the name of the device security group is case insensitive.
api-version	string	API version for the operation
resourceId	string	Optional filter for listing the assignments of a specific resource.

SELECT examples

get

Use this method to get the device security group for the specified IoT Hub resource.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.device_security_groups
WHERE deviceSecurityGroupName = '{{ deviceSecurityGroupName }}' -- required
AND api-version = '{{ api-version }}'
AND resourceId = '{{ resourceId }}'
;

list

Use this method get the list of device security groups for the specified IoT Hub resource.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.security.device_security_groups
WHERE api-version = '{{ api-version }}'
AND resourceId = '{{ resourceId }}'
;

INSERT examples

create_or_update

Use this method to creates or updates the device security group on a specified IoT Hub resource.

INSERT INTO azure.security.device_security_groups (
data__properties,
deviceSecurityGroupName,
api-version,
resourceId
)
SELECT 
'{{ properties }}',
'{{ deviceSecurityGroupName }}',
'{{ api-version }}',
'{{ resourceId }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: device_security_groups
  props:
    - name: deviceSecurityGroupName
      value: string
      description: Required parameter for the device_security_groups resource.
    - name: properties
      value: object
      description: |
        Device Security group data
    - name: api-version
      value: string
      description: API version for the operation
    - name: resourceId
      value: string
      description: Optional filter for listing the assignments of a specific resource.

DELETE examples

delete

User this method to deletes the device security group.

DELETE FROM azure.security.device_security_groups
WHERE deviceSecurityGroupName = '{{ deviceSecurityGroupName }}' --required
AND api-version = '{{ api-version }}'
AND resourceId = '{{ resourceId }}'
;