Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. alertsmanagement
  5. getSmartDetectorAlertRule
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.alertsmanagement.getSmartDetectorAlertRule

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Get a specific Smart Detector alert rule. API Version: 2019-06-01.

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

    DetectorResponse

    Id string
    The detector id.
    Description string
    The Smart Detector description. By default this is not populated, unless it's specified in expandDetector
    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. By default this is not populated, unless it's specified in expandDetector
    Parameters Dictionary<string, object>
    The detector's parameters.'
    SupportedResourceTypes List<string>
    The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector
    Id string
    The detector id.
    Description string
    The Smart Detector description. By default this is not populated, unless it's specified in expandDetector
    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. By default this is not populated, unless it's specified in expandDetector
    Parameters map[string]interface{}
    The detector's parameters.'
    SupportedResourceTypes []string
    The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector
    id String
    The detector id.
    description String
    The Smart Detector description. By default this is not populated, unless it's specified in expandDetector
    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. By default this is not populated, unless it's specified in expandDetector
    parameters Map<String,Object>
    The detector's parameters.'
    supportedResourceTypes List<String>
    The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector
    id string
    The detector id.
    description string
    The Smart Detector description. By default this is not populated, unless it's specified in expandDetector
    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. By default this is not populated, unless it's specified in expandDetector
    parameters {[key: string]: any}
    The detector's parameters.'
    supportedResourceTypes string[]
    The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector
    id str
    The detector id.
    description str
    The Smart Detector description. By default this is not populated, unless it's specified in expandDetector
    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. By default this is not populated, unless it's specified in expandDetector
    parameters Mapping[str, Any]
    The detector's parameters.'
    supported_resource_types Sequence[str]
    The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector
    id String
    The detector id.
    description String
    The Smart Detector description. By default this is not populated, unless it's specified in expandDetector
    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. By default this is not populated, unless it's specified in expandDetector
    parameters Map<Any>
    The detector's parameters.'
    supportedResourceTypes List<String>
    The Smart Detector supported resource types. By default this is not populated, unless it's specified in expandDetector

    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-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native