azure-native.security.getDeviceSecurityGroup
Explore with Pulumi AI
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>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)
public static Output<GetDeviceSecurityGroupResult> getDeviceSecurityGroup(GetDeviceSecurityGroupArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:security:getDeviceSecurityGroup
  arguments:
    # arguments dictionaryThe following arguments are supported:
- Device
Security stringGroup Name  - The name of the device security group. Note that the name of the device security group is case insensitive.
 - Resource
Id string - The identifier of the resource.
 
- Device
Security stringGroup Name  - The name of the device security group. Note that the name of the device security group is case insensitive.
 - Resource
Id string - The identifier of the resource.
 
- device
Security StringGroup Name  - The name of the device security group. Note that the name of the device security group is case insensitive.
 - resource
Id String - The identifier of the resource.
 
- device
Security stringGroup Name  - The name of the device security group. Note that the name of the device security group is case insensitive.
 - resource
Id string - The identifier of the resource.
 
- device_
security_ strgroup_ name  - 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.
 
- device
Security StringGroup Name  - The name of the device security group. Note that the name of the device security group is case insensitive.
 - resource
Id String - The identifier of the resource.
 
getDeviceSecurityGroup Result
The following output properties are available:
- Azure
Api stringVersion  - The Azure API version of the resource.
 - Id string
 - Resource Id
 - Name string
 - Resource name
 - Type string
 - Resource type
 - Allowlist
Rules List<Pulumi.Azure Native. Security. Outputs. Allowlist Custom Alert Rule Response>  - The allow-list custom alert rules.
 - Denylist
Rules List<Pulumi.Azure Native. Security. Outputs. Denylist Custom Alert Rule Response>  - The deny-list custom alert rules.
 - Threshold
Rules List<Pulumi.Azure Native. Security. Outputs. Threshold Custom Alert Rule Response>  - The list of custom alert threshold rules.
 - Time
Window List<Pulumi.Rules Azure Native. Security. Outputs. Time Window Custom Alert Rule Response>  - The list of custom alert time-window rules.
 
- Azure
Api stringVersion  - The Azure API version of the resource.
 - Id string
 - Resource Id
 - Name string
 - Resource name
 - Type string
 - Resource type
 - Allowlist
Rules []AllowlistCustom Alert Rule Response  - The allow-list custom alert rules.
 - Denylist
Rules []DenylistCustom Alert Rule Response  - The deny-list custom alert rules.
 - Threshold
Rules []ThresholdCustom Alert Rule Response  - The list of custom alert threshold rules.
 - Time
Window []TimeRules Window Custom Alert Rule Response  - The list of custom alert time-window rules.
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - id String
 - Resource Id
 - name String
 - Resource name
 - type String
 - Resource type
 - allowlist
Rules List<AllowlistCustom Alert Rule Response>  - The allow-list custom alert rules.
 - denylist
Rules List<DenylistCustom Alert Rule Response>  - The deny-list custom alert rules.
 - threshold
Rules List<ThresholdCustom Alert Rule Response>  - The list of custom alert threshold rules.
 - time
Window List<TimeRules Window Custom Alert Rule Response>  - The list of custom alert time-window rules.
 
- azure
Api stringVersion  - The Azure API version of the resource.
 - id string
 - Resource Id
 - name string
 - Resource name
 - type string
 - Resource type
 - allowlist
Rules AllowlistCustom Alert Rule Response[]  - The allow-list custom alert rules.
 - denylist
Rules DenylistCustom Alert Rule Response[]  - The deny-list custom alert rules.
 - threshold
Rules ThresholdCustom Alert Rule Response[]  - The list of custom alert threshold rules.
 - time
Window TimeRules Window Custom Alert Rule Response[]  - The list of custom alert time-window rules.
 
- azure_
api_ strversion  - The Azure API version of the resource.
 - id str
 - Resource Id
 - name str
 - Resource name
 - type str
 - Resource type
 - allowlist_
rules Sequence[AllowlistCustom Alert Rule Response]  - The allow-list custom alert rules.
 - denylist_
rules Sequence[DenylistCustom Alert Rule Response]  - The deny-list custom alert rules.
 - threshold_
rules Sequence[ThresholdCustom Alert Rule Response]  - The list of custom alert threshold rules.
 - time_
window_ Sequence[Timerules Window Custom Alert Rule Response]  - The list of custom alert time-window rules.
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - id String
 - Resource Id
 - name String
 - Resource name
 - type String
 - Resource type
 - allowlist
Rules List<Property Map> - The allow-list custom alert rules.
 - denylist
Rules List<Property Map> - The deny-list custom alert rules.
 - threshold
Rules List<Property Map> - The list of custom alert threshold rules.
 - time
Window List<Property Map>Rules  - The list of custom alert time-window rules.
 
Supporting Types
AllowlistCustomAlertRuleResponse    
- 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.
 
- Allowlist
Values []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.
 
- 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 Boolean - Status of the custom alert.
 - value
Type String - The value type of the items in the list.
 
- allowlist
Values 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 boolean - Status of the custom alert.
 - value
Type 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.
 
- 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 Boolean - Status of the custom alert.
 - value
Type String - The value type of the items in the list.
 
DenylistCustomAlertRuleResponse    
- 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.
 
- Denylist
Values []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.
 
- 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 Boolean - Status of the custom alert.
 - value
Type String - The value type of the items in the list.
 
- denylist
Values 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 boolean - Status of the custom alert.
 - value
Type 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.
 
- 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 Boolean - Status of the custom alert.
 - value
Type String - The value type of the items in the list.
 
ThresholdCustomAlertRuleResponse    
- 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 int - The maximum threshold.
 - Min
Threshold 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 int - The maximum threshold.
 - Min
Threshold int - The minimum threshold.
 
- description String
 - The description of the custom alert.
 - display
Name String - The display name of the custom alert.
 - is
Enabled Boolean - Status of the custom alert.
 - max
Threshold Integer - The maximum threshold.
 - min
Threshold Integer - The minimum threshold.
 
- description string
 - The description of the custom alert.
 - display
Name string - The display name of the custom alert.
 - is
Enabled boolean - Status of the custom alert.
 - max
Threshold number - The maximum threshold.
 - min
Threshold 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.
 - display
Name String - The display name of the custom alert.
 - is
Enabled Boolean - Status of the custom alert.
 - max
Threshold Number - The maximum threshold.
 - min
Threshold Number - The minimum threshold.
 
TimeWindowCustomAlertRuleResponse     
- 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 int - The maximum threshold.
 - Min
Threshold int - The minimum threshold.
 - Time
Window stringSize  - 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 int - The maximum threshold.
 - Min
Threshold int - The minimum threshold.
 - Time
Window stringSize  - 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 Boolean - Status of the custom alert.
 - max
Threshold Integer - The maximum threshold.
 - min
Threshold Integer - The minimum threshold.
 - time
Window StringSize  - 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 boolean - Status of the custom alert.
 - max
Threshold number - The maximum threshold.
 - min
Threshold number - The minimum threshold.
 - time
Window stringSize  - 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_ strsize  - 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 Boolean - Status of the custom alert.
 - max
Threshold Number - The maximum threshold.
 - min
Threshold Number - The minimum threshold.
 - time
Window StringSize  - The time window size in iso8601 format.
 
Package Details
- Repository
 - Azure Native pulumi/pulumi-azure-native
 - License
 - Apache-2.0