1. Registry
  2. Packages
  3. Azure Native
  4. API Docs
  5. security
  6. getDeviceSecurityGroup
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.26.0
published on Thursday, Aug 13, 2026 by Pulumi
azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Viewing docs for Azure Native v3.26.0
published on Thursday, Aug 13, 2026 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?: InvokeOutputOptions): Output<GetDeviceSecurityGroupResult>
    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: pulumi.Input[Optional[str]] = None,
                                  resource_id: pulumi.Input[Optional[str]] = None,
                                  opts: Optional[InvokeOutputOptions] = None) -> Output[GetDeviceSecurityGroupResult]
    func LookupDeviceSecurityGroup(ctx *Context, args *LookupDeviceSecurityGroupArgs, opts ...InvokeOption) (*LookupDeviceSecurityGroupResult, error)
    func LookupDeviceSecurityGroupOutput(ctx *Context, args *LookupDeviceSecurityGroupOutputArgs, opts ...InvokeOption) LookupDeviceSecurityGroupResultOutput

    > 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)
        public static Output<GetDeviceSecurityGroupResult> Invoke(GetDeviceSecurityGroupInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetDeviceSecurityGroupResult> getDeviceSecurityGroup(GetDeviceSecurityGroupArgs args, InvokeOptions options)
    public static Output<GetDeviceSecurityGroupResult> getDeviceSecurityGroup(GetDeviceSecurityGroupArgs args, InvokeOptions options)
    public static Output<GetDeviceSecurityGroupResult> getDeviceSecurityGroup(GetDeviceSecurityGroupArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: azure-native:security:getDeviceSecurityGroup
      arguments:
        # arguments dictionary
    data "azure-native_security_get_device_security_group" "name" {
        # arguments
    }

    The following arguments are supported:

    DeviceSecurityGroupName string
    The name of the device security group. Note that the name of the device security group is case insensitive.
    ResourceId string
    The fully qualified Azure Resource manager 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.
    ResourceId string
    The fully qualified Azure Resource manager identifier of the resource.
    device_security_group_name string
    The name of the device security group. Note that the name of the device security group is case insensitive.
    resource_id string
    The fully qualified Azure Resource manager 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.
    resourceId String
    The fully qualified Azure Resource manager 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.
    resourceId string
    The fully qualified Azure Resource manager identifier of the resource.
    device_security_group_name str
    The name of the device security group. Note that the name of the device security group is case insensitive.
    resource_id str
    The fully qualified Azure Resource manager 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.
    resourceId String
    The fully qualified Azure Resource manager identifier of the resource.

    getDeviceSecurityGroup Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    SystemData Pulumi.AzureNative.Security.Outputs.SystemDataResponse
    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"
    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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    Name string
    The name of the resource
    SystemData SystemDataResponse
    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"
    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 string
    The Azure API version of the resource.
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    system_data 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"
    allowlist_rules list(object)
    The allow-list custom alert rules.
    denylist_rules list(object)
    The deny-list custom alert rules.
    threshold_rules list(object)
    The list of custom alert threshold rules.
    time_window_rules list(object)
    The list of custom alert time-window rules.
    azureApiVersion String
    The Azure API version of the resource.
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    systemData SystemDataResponse
    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"
    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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name string
    The name of the resource
    systemData SystemDataResponse
    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"
    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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name str
    The name of the resource
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    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
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    name String
    The name of the resource
    systemData Property Map
    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"
    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 List<string>
    The values to allow. The format of the values depends on the rule type.
    Description string
    The description of the custom alert.
    DisplayName string
    The display name of the custom alert.
    IsEnabled bool
    Status of the custom alert.
    ValueType string
    The value type of the items in the list.
    AllowlistValues []string
    The values to allow. The format of the values depends on the rule type.
    Description string
    The description of the custom alert.
    DisplayName string
    The display name of the custom alert.
    IsEnabled bool
    Status of the custom alert.
    ValueType string
    The value type of the items in the list.
    allowlist_values list(string)
    The values to allow. The format of the values depends on the rule type.
    description string
    The description of the custom alert.
    display_name string
    The display name of the custom alert.
    is_enabled bool
    Status of the custom alert.
    value_type string
    The value type of the items in the list.
    allowlistValues List<String>
    The values to allow. The format of the values depends on the rule type.
    description String
    The description of the custom alert.
    displayName String
    The display name of the custom alert.
    isEnabled Boolean
    Status of the custom alert.
    valueType String
    The value type of the items in the list.
    allowlistValues string[]
    The values to allow. The format of the values depends on the rule type.
    description string
    The description of the custom alert.
    displayName string
    The display name of the custom alert.
    isEnabled boolean
    Status of the custom alert.
    valueType string
    The value type of the items in the list.
    allowlist_values Sequence[str]
    The values to allow. The format of the values depends on the rule type.
    description str
    The description of the custom alert.
    display_name str
    The display name of the custom alert.
    is_enabled bool
    Status of the custom alert.
    value_type str
    The value type of the items in the list.
    allowlistValues List<String>
    The values to allow. The format of the values depends on the rule type.
    description String
    The description of the custom alert.
    displayName String
    The display name of the custom alert.
    isEnabled Boolean
    Status of the custom alert.
    valueType String
    The value type of the items in the list.

    DenylistCustomAlertRuleResponse

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

    SystemDataResponse

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    created_at string
    The timestamp of resource creation (UTC).
    created_by string
    The identity that created the resource.
    created_by_type string
    The type of identity that created the resource.
    last_modified_at string
    The timestamp of resource last modification (UTC)
    last_modified_by string
    The identity that last modified the resource.
    last_modified_by_type string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    The type of identity that last modified the resource.
    created_at str
    The timestamp of resource creation (UTC).
    created_by str
    The identity that created the resource.
    created_by_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.

    ThresholdCustomAlertRuleResponse

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

    TimeWindowCustomAlertRuleResponse

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

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Viewing docs for Azure Native v3.26.0
    published on Thursday, Aug 13, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial