azure-native.alertsmanagement.getSmartDetectorAlertRule
Explore with Pulumi AI
Get a specific Smart Detector alert rule. Azure REST API version: 2021-04-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:
- Alert
Rule stringName The name of the alert rule.
- Resource
Group stringName The name of the resource group.
- Expand
Detector bool Indicates if Smart Detector should be expanded.
- Alert
Rule stringName The name of the alert rule.
- Resource
Group stringName The name of the resource group.
- Expand
Detector bool Indicates if Smart Detector should be expanded.
- alert
Rule StringName The name of the alert rule.
- resource
Group StringName The name of the resource group.
- expand
Detector Boolean Indicates if Smart Detector should be expanded.
- alert
Rule stringName The name of the alert rule.
- resource
Group stringName The name of the resource group.
- expand
Detector boolean Indicates if Smart Detector should be expanded.
- alert_
rule_ strname The name of the alert rule.
- resource_
group_ strname The name of the resource group.
- expand_
detector bool Indicates if Smart Detector should be expanded.
- alert
Rule StringName The name of the alert rule.
- resource
Group StringName The name of the resource group.
- expand
Detector Boolean Indicates if Smart Detector should be expanded.
getSmartDetectorAlertRule Result
The following output properties are available:
- Action
Groups Pulumi.Azure Native. Alerts Management. Outputs. Action Groups Information Response The alert rule actions.
- Detector
Pulumi.
Azure Native. Alerts Management. Outputs. Detector Response 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.
- Dictionary<string, string>
The resource tags.
- Throttling
Pulumi.
Azure Native. Alerts Management. Outputs. Throttling Information Response The alert rule throttling information.
- Action
Groups ActionGroups Information Response The alert rule actions.
- Detector
Detector
Response 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.
- map[string]string
The resource tags.
- Throttling
Throttling
Information Response The alert rule throttling information.
- action
Groups ActionGroups Information Response The alert rule actions.
- detector
Detector
Response 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.
- Map<String,String>
The resource tags.
- throttling
Throttling
Information Response The alert rule throttling information.
- action
Groups ActionGroups Information Response The alert rule actions.
- detector
Detector
Response 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.
- {[key: string]: string}
The resource tags.
- throttling
Throttling
Information Response The alert rule throttling information.
- action_
groups ActionGroups Information Response The alert rule actions.
- detector
Detector
Response 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.
- Mapping[str, str]
The resource tags.
- throttling
Throttling
Information Response The alert rule throttling information.
- action
Groups 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.
- Map<String>
The resource tags.
- throttling Property Map
The alert rule throttling information.
Supporting Types
ActionGroupsInformationResponse
- Group
Ids List<string> The Action Group resource IDs.
- Custom
Email stringSubject An optional custom email subject to use in email notifications.
- Custom
Webhook stringPayload An optional custom web-hook payload to use in web-hook notifications.
- Group
Ids []string The Action Group resource IDs.
- Custom
Email stringSubject An optional custom email subject to use in email notifications.
- Custom
Webhook stringPayload An optional custom web-hook payload to use in web-hook notifications.
- group
Ids List<String> The Action Group resource IDs.
- custom
Email StringSubject An optional custom email subject to use in email notifications.
- custom
Webhook StringPayload An optional custom web-hook payload to use in web-hook notifications.
- group
Ids string[] The Action Group resource IDs.
- custom
Email stringSubject An optional custom email subject to use in email notifications.
- custom
Webhook stringPayload An optional custom web-hook payload to use in web-hook notifications.
- group_
ids Sequence[str] The Action Group resource IDs.
- custom_
email_ strsubject An optional custom email subject to use in email notifications.
- custom_
webhook_ strpayload An optional custom web-hook payload to use in web-hook notifications.
- group
Ids List<String> The Action Group resource IDs.
- custom
Email StringSubject An optional custom email subject to use in email notifications.
- custom
Webhook StringPayload An optional custom web-hook payload to use in web-hook notifications.
DetectorParameterDefinitionResponse
- Description string
The detector parameter description.
- Display
Name string The detector parameter display name.
- Is
Mandatory 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.
- Display
Name string The detector parameter display name.
- Is
Mandatory 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.
- display
Name String The detector parameter display name.
- is
Mandatory 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.
- display
Name string The detector parameter display name.
- is
Mandatory 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.
- display
Name String The detector parameter display name.
- is
Mandatory 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.
- Image
Paths 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.
- Parameter
Definitions List<Pulumi.Azure Native. Alerts Management. Inputs. Detector Parameter Definition Response> The Smart Detector parameters definitions.'
- Supported
Cadences List<int> The Smart Detector supported cadences.
- Supported
Resource List<string>Types 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.
- Image
Paths []string The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector
- Name string
The Smart Detector name.
- Parameter
Definitions []DetectorParameter Definition Response The Smart Detector parameters definitions.'
- Supported
Cadences []int The Smart Detector supported cadences.
- Supported
Resource []stringTypes 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.
- image
Paths 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.
- parameter
Definitions List<DetectorParameter Definition Response> The Smart Detector parameters definitions.'
- supported
Cadences List<Integer> The Smart Detector supported cadences.
- supported
Resource List<String>Types 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.
- image
Paths string[] The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector
- name string
The Smart Detector name.
- parameter
Definitions DetectorParameter Definition Response[] The Smart Detector parameters definitions.'
- supported
Cadences number[] The Smart Detector supported cadences.
- supported
Resource string[]Types 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[DetectorParameter Definition Response] The Smart Detector parameters definitions.'
- supported_
cadences Sequence[int] The Smart Detector supported cadences.
- supported_
resource_ Sequence[str]types 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.
- image
Paths 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.
- parameter
Definitions List<Property Map> The Smart Detector parameters definitions.'
- supported
Cadences List<Number> The Smart Detector supported cadences.
- supported
Resource List<String>Types 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