1. Packages
  2. Azure Native
  3. API Docs
  4. security
  5. getDeviceSecurityGroup
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

azure-native.security.getDeviceSecurityGroup

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi

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

Uses Azure REST API version 2019-08-01.

Other available API versions: 2017-08-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native security [ApiVersion]. See the version guide for details.

Using getDeviceSecurityGroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getDeviceSecurityGroup(args: GetDeviceSecurityGroupArgs, opts?: InvokeOptions): Promise<GetDeviceSecurityGroupResult>
function getDeviceSecurityGroupOutput(args: GetDeviceSecurityGroupOutputArgs, opts?: InvokeOptions): Output<GetDeviceSecurityGroupResult>
Copy
def get_device_security_group(device_security_group_name: Optional[str] = None,
                              resource_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetDeviceSecurityGroupResult
def get_device_security_group_output(device_security_group_name: Optional[pulumi.Input[str]] = None,
                              resource_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetDeviceSecurityGroupResult]
Copy
func LookupDeviceSecurityGroup(ctx *Context, args *LookupDeviceSecurityGroupArgs, opts ...InvokeOption) (*LookupDeviceSecurityGroupResult, error)
func LookupDeviceSecurityGroupOutput(ctx *Context, args *LookupDeviceSecurityGroupOutputArgs, opts ...InvokeOption) LookupDeviceSecurityGroupResultOutput
Copy

> Note: This function is named LookupDeviceSecurityGroup in the Go SDK.

public static class GetDeviceSecurityGroup 
{
    public static Task<GetDeviceSecurityGroupResult> InvokeAsync(GetDeviceSecurityGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetDeviceSecurityGroupResult> Invoke(GetDeviceSecurityGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDeviceSecurityGroupResult> getDeviceSecurityGroup(GetDeviceSecurityGroupArgs args, InvokeOptions options)
public static Output<GetDeviceSecurityGroupResult> getDeviceSecurityGroup(GetDeviceSecurityGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:security:getDeviceSecurityGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DeviceSecurityGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the device security group. Note that the name of the device security group is case insensitive.
ResourceId
This property is required.
Changes to this property will trigger replacement.
string
The identifier of the resource.
DeviceSecurityGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the device security group. Note that the name of the device security group is case insensitive.
ResourceId
This property is required.
Changes to this property will trigger replacement.
string
The identifier of the resource.
deviceSecurityGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the device security group. Note that the name of the device security group is case insensitive.
resourceId
This property is required.
Changes to this property will trigger replacement.
String
The identifier of the resource.
deviceSecurityGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the device security group. Note that the name of the device security group is case insensitive.
resourceId
This property is required.
Changes to this property will trigger replacement.
string
The identifier of the resource.
device_security_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the device security group. Note that the name of the device security group is case insensitive.
resource_id
This property is required.
Changes to this property will trigger replacement.
str
The identifier of the resource.
deviceSecurityGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the device security group. Note that the name of the device security group is case insensitive.
resourceId
This property is required.
Changes to this property will trigger replacement.
String
The identifier of the resource.

getDeviceSecurityGroup Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Resource Id
Name string
Resource name
Type string
Resource type
AllowlistRules List<Pulumi.AzureNative.Security.Outputs.AllowlistCustomAlertRuleResponse>
The allow-list custom alert rules.
DenylistRules List<Pulumi.AzureNative.Security.Outputs.DenylistCustomAlertRuleResponse>
The deny-list custom alert rules.
ThresholdRules List<Pulumi.AzureNative.Security.Outputs.ThresholdCustomAlertRuleResponse>
The list of custom alert threshold rules.
TimeWindowRules List<Pulumi.AzureNative.Security.Outputs.TimeWindowCustomAlertRuleResponse>
The list of custom alert time-window rules.
AzureApiVersion string
The Azure API version of the resource.
Id string
Resource Id
Name string
Resource name
Type string
Resource type
AllowlistRules []AllowlistCustomAlertRuleResponse
The allow-list custom alert rules.
DenylistRules []DenylistCustomAlertRuleResponse
The deny-list custom alert rules.
ThresholdRules []ThresholdCustomAlertRuleResponse
The list of custom alert threshold rules.
TimeWindowRules []TimeWindowCustomAlertRuleResponse
The list of custom alert time-window rules.
azureApiVersion String
The Azure API version of the resource.
id String
Resource Id
name String
Resource name
type String
Resource type
allowlistRules List<AllowlistCustomAlertRuleResponse>
The allow-list custom alert rules.
denylistRules List<DenylistCustomAlertRuleResponse>
The deny-list custom alert rules.
thresholdRules List<ThresholdCustomAlertRuleResponse>
The list of custom alert threshold rules.
timeWindowRules List<TimeWindowCustomAlertRuleResponse>
The list of custom alert time-window rules.
azureApiVersion string
The Azure API version of the resource.
id string
Resource Id
name string
Resource name
type string
Resource type
allowlistRules AllowlistCustomAlertRuleResponse[]
The allow-list custom alert rules.
denylistRules DenylistCustomAlertRuleResponse[]
The deny-list custom alert rules.
thresholdRules ThresholdCustomAlertRuleResponse[]
The list of custom alert threshold rules.
timeWindowRules TimeWindowCustomAlertRuleResponse[]
The list of custom alert time-window rules.
azure_api_version str
The Azure API version of the resource.
id str
Resource Id
name str
Resource name
type str
Resource type
allowlist_rules Sequence[AllowlistCustomAlertRuleResponse]
The allow-list custom alert rules.
denylist_rules Sequence[DenylistCustomAlertRuleResponse]
The deny-list custom alert rules.
threshold_rules Sequence[ThresholdCustomAlertRuleResponse]
The list of custom alert threshold rules.
time_window_rules Sequence[TimeWindowCustomAlertRuleResponse]
The list of custom alert time-window rules.
azureApiVersion String
The Azure API version of the resource.
id String
Resource Id
name String
Resource name
type String
Resource type
allowlistRules List<Property Map>
The allow-list custom alert rules.
denylistRules List<Property Map>
The deny-list custom alert rules.
thresholdRules List<Property Map>
The list of custom alert threshold rules.
timeWindowRules List<Property Map>
The list of custom alert time-window rules.

Supporting Types

AllowlistCustomAlertRuleResponse

AllowlistValues This property is required. List<string>
The values to allow. The format of the values depends on the rule type.
Description This property is required. string
The description of the custom alert.
DisplayName This property is required. string
The display name of the custom alert.
IsEnabled This property is required. bool
Status of the custom alert.
ValueType This property is required. string
The value type of the items in the list.
AllowlistValues This property is required. []string
The values to allow. The format of the values depends on the rule type.
Description This property is required. string
The description of the custom alert.
DisplayName This property is required. string
The display name of the custom alert.
IsEnabled This property is required. bool
Status of the custom alert.
ValueType This property is required. string
The value type of the items in the list.
allowlistValues This property is required. List<String>
The values to allow. The format of the values depends on the rule type.
description This property is required. String
The description of the custom alert.
displayName This property is required. String
The display name of the custom alert.
isEnabled This property is required. Boolean
Status of the custom alert.
valueType This property is required. String
The value type of the items in the list.
allowlistValues This property is required. string[]
The values to allow. The format of the values depends on the rule type.
description This property is required. string
The description of the custom alert.
displayName This property is required. string
The display name of the custom alert.
isEnabled This property is required. boolean
Status of the custom alert.
valueType This property is required. string
The value type of the items in the list.
allowlist_values This property is required. Sequence[str]
The values to allow. The format of the values depends on the rule type.
description This property is required. str
The description of the custom alert.
display_name This property is required. str
The display name of the custom alert.
is_enabled This property is required. bool
Status of the custom alert.
value_type This property is required. str
The value type of the items in the list.
allowlistValues This property is required. List<String>
The values to allow. The format of the values depends on the rule type.
description This property is required. String
The description of the custom alert.
displayName This property is required. String
The display name of the custom alert.
isEnabled This property is required. Boolean
Status of the custom alert.
valueType This property is required. String
The value type of the items in the list.

DenylistCustomAlertRuleResponse

DenylistValues This property is required. List<string>
The values to deny. The format of the values depends on the rule type.
Description This property is required. string
The description of the custom alert.
DisplayName This property is required. string
The display name of the custom alert.
IsEnabled This property is required. bool
Status of the custom alert.
ValueType This property is required. string
The value type of the items in the list.
DenylistValues This property is required. []string
The values to deny. The format of the values depends on the rule type.
Description This property is required. string
The description of the custom alert.
DisplayName This property is required. string
The display name of the custom alert.
IsEnabled This property is required. bool
Status of the custom alert.
ValueType This property is required. string
The value type of the items in the list.
denylistValues This property is required. List<String>
The values to deny. The format of the values depends on the rule type.
description This property is required. String
The description of the custom alert.
displayName This property is required. String
The display name of the custom alert.
isEnabled This property is required. Boolean
Status of the custom alert.
valueType This property is required. String
The value type of the items in the list.
denylistValues This property is required. string[]
The values to deny. The format of the values depends on the rule type.
description This property is required. string
The description of the custom alert.
displayName This property is required. string
The display name of the custom alert.
isEnabled This property is required. boolean
Status of the custom alert.
valueType This property is required. string
The value type of the items in the list.
denylist_values This property is required. Sequence[str]
The values to deny. The format of the values depends on the rule type.
description This property is required. str
The description of the custom alert.
display_name This property is required. str
The display name of the custom alert.
is_enabled This property is required. bool
Status of the custom alert.
value_type This property is required. str
The value type of the items in the list.
denylistValues This property is required. List<String>
The values to deny. The format of the values depends on the rule type.
description This property is required. String
The description of the custom alert.
displayName This property is required. String
The display name of the custom alert.
isEnabled This property is required. Boolean
Status of the custom alert.
valueType This property is required. String
The value type of the items in the list.

ThresholdCustomAlertRuleResponse

Description This property is required. string
The description of the custom alert.
DisplayName This property is required. string
The display name of the custom alert.
IsEnabled This property is required. bool
Status of the custom alert.
MaxThreshold This property is required. int
The maximum threshold.
MinThreshold This property is required. int
The minimum threshold.
Description This property is required. string
The description of the custom alert.
DisplayName This property is required. string
The display name of the custom alert.
IsEnabled This property is required. bool
Status of the custom alert.
MaxThreshold This property is required. int
The maximum threshold.
MinThreshold This property is required. int
The minimum threshold.
description This property is required. String
The description of the custom alert.
displayName This property is required. String
The display name of the custom alert.
isEnabled This property is required. Boolean
Status of the custom alert.
maxThreshold This property is required. Integer
The maximum threshold.
minThreshold This property is required. Integer
The minimum threshold.
description This property is required. string
The description of the custom alert.
displayName This property is required. string
The display name of the custom alert.
isEnabled This property is required. boolean
Status of the custom alert.
maxThreshold This property is required. number
The maximum threshold.
minThreshold This property is required. number
The minimum threshold.
description This property is required. str
The description of the custom alert.
display_name This property is required. str
The display name of the custom alert.
is_enabled This property is required. bool
Status of the custom alert.
max_threshold This property is required. int
The maximum threshold.
min_threshold This property is required. int
The minimum threshold.
description This property is required. String
The description of the custom alert.
displayName This property is required. String
The display name of the custom alert.
isEnabled This property is required. Boolean
Status of the custom alert.
maxThreshold This property is required. Number
The maximum threshold.
minThreshold This property is required. Number
The minimum threshold.

TimeWindowCustomAlertRuleResponse

Description This property is required. string
The description of the custom alert.
DisplayName This property is required. string
The display name of the custom alert.
IsEnabled This property is required. bool
Status of the custom alert.
MaxThreshold This property is required. int
The maximum threshold.
MinThreshold This property is required. int
The minimum threshold.
TimeWindowSize This property is required. string
The time window size in iso8601 format.
Description This property is required. string
The description of the custom alert.
DisplayName This property is required. string
The display name of the custom alert.
IsEnabled This property is required. bool
Status of the custom alert.
MaxThreshold This property is required. int
The maximum threshold.
MinThreshold This property is required. int
The minimum threshold.
TimeWindowSize This property is required. string
The time window size in iso8601 format.
description This property is required. String
The description of the custom alert.
displayName This property is required. String
The display name of the custom alert.
isEnabled This property is required. Boolean
Status of the custom alert.
maxThreshold This property is required. Integer
The maximum threshold.
minThreshold This property is required. Integer
The minimum threshold.
timeWindowSize This property is required. String
The time window size in iso8601 format.
description This property is required. string
The description of the custom alert.
displayName This property is required. string
The display name of the custom alert.
isEnabled This property is required. boolean
Status of the custom alert.
maxThreshold This property is required. number
The maximum threshold.
minThreshold This property is required. number
The minimum threshold.
timeWindowSize This property is required. string
The time window size in iso8601 format.
description This property is required. str
The description of the custom alert.
display_name This property is required. str
The display name of the custom alert.
is_enabled This property is required. bool
Status of the custom alert.
max_threshold This property is required. int
The maximum threshold.
min_threshold This property is required. int
The minimum threshold.
time_window_size This property is required. str
The time window size in iso8601 format.
description This property is required. String
The description of the custom alert.
displayName This property is required. String
The display name of the custom alert.
isEnabled This property is required. Boolean
Status of the custom alert.
maxThreshold This property is required. Number
The maximum threshold.
minThreshold This property is required. Number
The minimum threshold.
timeWindowSize This property is required. String
The time window size in iso8601 format.

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.1.0 published on Tuesday, Apr 8, 2025 by Pulumi