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

azure-native.security.getDeviceSecurityGroup

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.36.0 published on Monday, Apr 8, 2024 by Pulumi

    Use this method to get the device security group for the specified IoT Hub resource. Azure REST API version: 2019-08-01.

    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>
    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]
    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 CompletableFuture<GetDeviceSecurityGroupResult> getDeviceSecurityGroup(GetDeviceSecurityGroupArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:security:getDeviceSecurityGroup
      arguments:
        # arguments dictionary

    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 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 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 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 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 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 identifier of the resource.

    getDeviceSecurityGroup Result

    The following output properties are available:

    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.
    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.
    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.
    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.
    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 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.
    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.
    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.

    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.
    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.
    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 v1 docs if using the v1 version of this package.
    Azure Native v2.36.0 published on Monday, Apr 8, 2024 by Pulumi