DeviceSecurityGroups interface

Package:

@azure/arm-security

Interface representing a DeviceSecurityGroups.

Methods

createOrUpdate(string, string, DeviceSecurityGroup, DeviceSecurityGroupsCreateOrUpdateOptionalParams)	Use this method to creates or updates the device security group on a specified IoT Hub resource.
delete(string, string, DeviceSecurityGroupsDeleteOptionalParams)	User this method to deletes the device security group.
get(string, string, DeviceSecurityGroupsGetOptionalParams)	Use this method to get the device security group for the specified IoT Hub resource.
list(string, DeviceSecurityGroupsListOptionalParams)	Use this method get the list of device security groups for the specified IoT Hub resource.

Method Details

createOrUpdate(string, string, DeviceSecurityGroup, DeviceSecurityGroupsCreateOrUpdateOptionalParams)

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

function createOrUpdate(resourceId: string, deviceSecurityGroupName: string, deviceSecurityGroup: DeviceSecurityGroup, options?: DeviceSecurityGroupsCreateOrUpdateOptionalParams): Promise<DeviceSecurityGroup>

Parameters

resourceId

string

The identifier of the resource.

deviceSecurityGroupName

string

The name of the device security group. Note that the name of the device security group is case insensitive.

deviceSecurityGroup

DeviceSecurityGroup

Security group object.

options

DeviceSecurityGroupsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<DeviceSecurityGroup>

delete(string, string, DeviceSecurityGroupsDeleteOptionalParams)

User this method to deletes the device security group.

function delete(resourceId: string, deviceSecurityGroupName: string, options?: DeviceSecurityGroupsDeleteOptionalParams): Promise<void>

Parameters

resourceId

string

The identifier of the resource.

deviceSecurityGroupName

string

The name of the device security group. Note that the name of the device security group is case insensitive.

options

DeviceSecurityGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, DeviceSecurityGroupsGetOptionalParams)

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

function get(resourceId: string, deviceSecurityGroupName: string, options?: DeviceSecurityGroupsGetOptionalParams): Promise<DeviceSecurityGroup>

Parameters

resourceId

string

The identifier of the resource.

deviceSecurityGroupName

string

The name of the device security group. Note that the name of the device security group is case insensitive.

options

DeviceSecurityGroupsGetOptionalParams

The options parameters.

Returns

Promise<DeviceSecurityGroup>

list(string, DeviceSecurityGroupsListOptionalParams)

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

function list(resourceId: string, options?: DeviceSecurityGroupsListOptionalParams): PagedAsyncIterableIterator<DeviceSecurityGroup, DeviceSecurityGroup[], PageSettings>

Parameters

resourceId

string

The identifier of the resource.

options

DeviceSecurityGroupsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<DeviceSecurityGroup, DeviceSecurityGroup[], PageSettings>