Azure Native v2.19.0, Nov 21 23

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.19.0 published on Tuesday, Nov 21, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.alertsmanagement.getSmartDetectorAlertRule

Explore with Pulumi AI

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.19.0 published on Tuesday, Nov 21, 2023 by Pulumi

pulumi/pulumi-azure-native

Using getSmartDetectorAlertRule

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 getSmartDetectorAlertRule(args: GetSmartDetectorAlertRuleArgs, opts?: InvokeOptions): Promise<GetSmartDetectorAlertRuleResult>
function getSmartDetectorAlertRuleOutput(args: GetSmartDetectorAlertRuleOutputArgs, opts?: InvokeOptions): Output<GetSmartDetectorAlertRuleResult>

def get_smart_detector_alert_rule(alert_rule_name: Optional[str] = None,
                                  expand_detector: Optional[bool] = None,
                                  resource_group_name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetSmartDetectorAlertRuleResult
def get_smart_detector_alert_rule_output(alert_rule_name: Optional[pulumi.Input[str]] = None,
                                  expand_detector: Optional[pulumi.Input[bool]] = None,
                                  resource_group_name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetSmartDetectorAlertRuleResult]

func LookupSmartDetectorAlertRule(ctx *Context, args *LookupSmartDetectorAlertRuleArgs, opts ...InvokeOption) (*LookupSmartDetectorAlertRuleResult, error)
func LookupSmartDetectorAlertRuleOutput(ctx *Context, args *LookupSmartDetectorAlertRuleOutputArgs, opts ...InvokeOption) LookupSmartDetectorAlertRuleResultOutput

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

public static class GetSmartDetectorAlertRule 
{
    public static Task<GetSmartDetectorAlertRuleResult> InvokeAsync(GetSmartDetectorAlertRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetSmartDetectorAlertRuleResult> Invoke(GetSmartDetectorAlertRuleInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSmartDetectorAlertRuleResult> getSmartDetectorAlertRule(GetSmartDetectorAlertRuleArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:alertsmanagement:getSmartDetectorAlertRule
  arguments:
    # arguments dictionary

The following arguments are supported:

AlertRuleName string: The name of the alert rule.
ResourceGroupName string: The name of the resource group.
ExpandDetector bool: Indicates if Smart Detector should be expanded.

AlertRuleName string: The name of the alert rule.
ResourceGroupName string: The name of the resource group.
ExpandDetector bool: Indicates if Smart Detector should be expanded.

alertRuleName String: The name of the alert rule.
resourceGroupName String: The name of the resource group.
expandDetector Boolean: Indicates if Smart Detector should be expanded.

alertRuleName string: The name of the alert rule.
resourceGroupName string: The name of the resource group.
expandDetector boolean: Indicates if Smart Detector should be expanded.

alert_rule_name str: The name of the alert rule.
resource_group_name str: The name of the resource group.
expand_detector bool: Indicates if Smart Detector should be expanded.

alertRuleName String: The name of the alert rule.
resourceGroupName String: The name of the resource group.
expandDetector Boolean: Indicates if Smart Detector should be expanded.

getSmartDetectorAlertRule Result

The following output properties are available:

ActionGroups Pulumi.AzureNative.AlertsManagement.Outputs.ActionGroupsInformationResponse: The alert rule actions.
Detector Pulumi.AzureNative.AlertsManagement.Outputs.DetectorResponse: The alert rule's detector.
Frequency string: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 1 minute, depending on the detector.
Id string: The resource ID.
Name string: The resource name.
Scope List<string>: The alert rule resources scope.
Severity string: The alert rule severity.
State string: The alert rule state.
Type string: The resource type.
Description string: The alert rule description.
Location string: The resource location.
Tags Dictionary<string, string>: The resource tags.
Throttling Pulumi.AzureNative.AlertsManagement.Outputs.ThrottlingInformationResponse: The alert rule throttling information.

ActionGroups ActionGroupsInformationResponse: The alert rule actions.
Detector DetectorResponse: The alert rule's detector.
Frequency string: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 1 minute, depending on the detector.
Id string: The resource ID.
Name string: The resource name.
Scope []string: The alert rule resources scope.
Severity string: The alert rule severity.
State string: The alert rule state.
Type string: The resource type.
Description string: The alert rule description.
Location string: The resource location.
Tags map[string]string: The resource tags.
Throttling ThrottlingInformationResponse: The alert rule throttling information.

actionGroups ActionGroupsInformationResponse: The alert rule actions.
detector DetectorResponse: The alert rule's detector.
frequency String: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 1 minute, depending on the detector.
id String: The resource ID.
name String: The resource name.
scope List<String>: The alert rule resources scope.
severity String: The alert rule severity.
state String: The alert rule state.
type String: The resource type.
description String: The alert rule description.
location String: The resource location.
tags Map<String,String>: The resource tags.
throttling ThrottlingInformationResponse: The alert rule throttling information.

actionGroups ActionGroupsInformationResponse: The alert rule actions.
detector DetectorResponse: The alert rule's detector.
frequency string: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 1 minute, depending on the detector.
id string: The resource ID.
name string: The resource name.
scope string[]: The alert rule resources scope.
severity string: The alert rule severity.
state string: The alert rule state.
type string: The resource type.
description string: The alert rule description.
location string: The resource location.
tags {[key: string]: string}: The resource tags.
throttling ThrottlingInformationResponse: The alert rule throttling information.

action_groups ActionGroupsInformationResponse: The alert rule actions.
detector DetectorResponse: The alert rule's detector.
frequency str: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 1 minute, depending on the detector.
id str: The resource ID.
name str: The resource name.
scope Sequence[str]: The alert rule resources scope.
severity str: The alert rule severity.
state str: The alert rule state.
type str: The resource type.
description str: The alert rule description.
location str: The resource location.
tags Mapping[str, str]: The resource tags.
throttling ThrottlingInformationResponse: The alert rule throttling information.

actionGroups Property Map: The alert rule actions.
detector Property Map: The alert rule's detector.
frequency String: The alert rule frequency in ISO8601 format. The time granularity must be in minutes and minimum value is 1 minute, depending on the detector.
id String: The resource ID.
name String: The resource name.
scope List<String>: The alert rule resources scope.
severity String: The alert rule severity.
state String: The alert rule state.
type String: The resource type.
description String: The alert rule description.
location String: The resource location.
tags Map<String>: The resource tags.
throttling Property Map: The alert rule throttling information.

Supporting Types

ActionGroupsInformationResponse

GroupIds List<string>: The Action Group resource IDs.
CustomEmailSubject string: An optional custom email subject to use in email notifications.
CustomWebhookPayload string: An optional custom web-hook payload to use in web-hook notifications.

GroupIds []string: The Action Group resource IDs.
CustomEmailSubject string: An optional custom email subject to use in email notifications.
CustomWebhookPayload string: An optional custom web-hook payload to use in web-hook notifications.

groupIds List<String>: The Action Group resource IDs.
customEmailSubject String: An optional custom email subject to use in email notifications.
customWebhookPayload String: An optional custom web-hook payload to use in web-hook notifications.

groupIds string[]: The Action Group resource IDs.
customEmailSubject string: An optional custom email subject to use in email notifications.
customWebhookPayload string: An optional custom web-hook payload to use in web-hook notifications.

group_ids Sequence[str]: The Action Group resource IDs.
custom_email_subject str: An optional custom email subject to use in email notifications.
custom_webhook_payload str: An optional custom web-hook payload to use in web-hook notifications.

groupIds List<String>: The Action Group resource IDs.
customEmailSubject String: An optional custom email subject to use in email notifications.
customWebhookPayload String: An optional custom web-hook payload to use in web-hook notifications.

DetectorParameterDefinitionResponse

Description string: The detector parameter description.
DisplayName string: The detector parameter display name.
IsMandatory bool: A value indicating whether this detector parameter is mandatory.
Name string: The detector parameter name.
Type string: The detector parameter type.

Description string: The detector parameter description.
DisplayName string: The detector parameter display name.
IsMandatory bool: A value indicating whether this detector parameter is mandatory.
Name string: The detector parameter name.
Type string: The detector parameter type.

description String: The detector parameter description.
displayName String: The detector parameter display name.
isMandatory Boolean: A value indicating whether this detector parameter is mandatory.
name String: The detector parameter name.
type String: The detector parameter type.

description string: The detector parameter description.
displayName string: The detector parameter display name.
isMandatory boolean: A value indicating whether this detector parameter is mandatory.
name string: The detector parameter name.
type string: The detector parameter type.

description str: The detector parameter description.
display_name str: The detector parameter display name.
is_mandatory bool: A value indicating whether this detector parameter is mandatory.
name str: The detector parameter name.
type str: The detector parameter type.

description String: The detector parameter description.
displayName String: The detector parameter display name.
isMandatory Boolean: A value indicating whether this detector parameter is mandatory.
name String: The detector parameter name.
type String: The detector parameter type.

DetectorResponse

Description string: The Smart Detector description.
Id string: The detector id.
ImagePaths List<string>: The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector
Name string: The Smart Detector name.
ParameterDefinitions List<Pulumi.AzureNative.AlertsManagement.Inputs.DetectorParameterDefinitionResponse>: The Smart Detector parameters definitions.'
SupportedCadences List<int>: The Smart Detector supported cadences.
SupportedResourceTypes List<string>: The Smart Detector supported resource types.
Parameters Dictionary<string, object>: The detector's parameters.'

Description string: The Smart Detector description.
Id string: The detector id.
ImagePaths []string: The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector
Name string: The Smart Detector name.
ParameterDefinitions []DetectorParameterDefinitionResponse: The Smart Detector parameters definitions.'
SupportedCadences []int: The Smart Detector supported cadences.
SupportedResourceTypes []string: The Smart Detector supported resource types.
Parameters map[string]interface{}: The detector's parameters.'

description String: The Smart Detector description.
id String: The detector id.
imagePaths List<String>: The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector
name String: The Smart Detector name.
parameterDefinitions List<DetectorParameterDefinitionResponse>: The Smart Detector parameters definitions.'
supportedCadences List<Integer>: The Smart Detector supported cadences.
supportedResourceTypes List<String>: The Smart Detector supported resource types.
parameters Map<String,Object>: The detector's parameters.'

description string: The Smart Detector description.
id string: The detector id.
imagePaths string[]: The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector
name string: The Smart Detector name.
parameterDefinitions DetectorParameterDefinitionResponse[]: The Smart Detector parameters definitions.'
supportedCadences number[]: The Smart Detector supported cadences.
supportedResourceTypes string[]: The Smart Detector supported resource types.
parameters {[key: string]: any}: The detector's parameters.'

description str: The Smart Detector description.
id str: The detector id.
image_paths Sequence[str]: The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector
name str: The Smart Detector name.
parameter_definitions Sequence[DetectorParameterDefinitionResponse]: The Smart Detector parameters definitions.'
supported_cadences Sequence[int]: The Smart Detector supported cadences.
supported_resource_types Sequence[str]: The Smart Detector supported resource types.
parameters Mapping[str, Any]: The detector's parameters.'

description String: The Smart Detector description.
id String: The detector id.
imagePaths List<String>: The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector
name String: The Smart Detector name.
parameterDefinitions List<Property Map>: The Smart Detector parameters definitions.'
supportedCadences List<Number>: The Smart Detector supported cadences.
supportedResourceTypes List<String>: The Smart Detector supported resource types.
parameters Map<Any>: The detector's parameters.'

ThrottlingInformationResponse

Duration string: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes

Duration string: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes

duration String: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes

duration string: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes

duration str: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes

duration String: The required duration (in ISO8601 format) to wait before notifying on the alert rule again. The time granularity must be in minutes and minimum value is 0 minutes

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 v1 docs if using the v1 version of this package.

Azure Native v2.19.0 published on Tuesday, Nov 21, 2023 by Pulumi

pulumi/pulumi-azure-native

azure-native.alertsmanagement.getSmartDetectorAlertRule

On this page

On this page

Using getSmartDetectorAlertRule

getSmartDetectorAlertRule Result

Supporting Types

ActionGroupsInformationResponse

DetectorParameterDefinitionResponse

DetectorResponse

ThrottlingInformationResponse

Package Details

On this page

On this page