azure-native-v2.alertsmanagement.SmartDetectorAlertRule
Explore with Pulumi AI
The alert rule information Azure REST API version: 2021-04-01. Prior API version in Azure Native 1.x: 2019-06-01.
Create SmartDetectorAlertRule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SmartDetectorAlertRule(name: string, args: SmartDetectorAlertRuleArgs, opts?: CustomResourceOptions);
@overload
def SmartDetectorAlertRule(resource_name: str,
args: SmartDetectorAlertRuleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SmartDetectorAlertRule(resource_name: str,
opts: Optional[ResourceOptions] = None,
action_groups: Optional[ActionGroupsInformationArgs] = None,
detector: Optional[DetectorArgs] = None,
frequency: Optional[str] = None,
resource_group_name: Optional[str] = None,
scope: Optional[Sequence[str]] = None,
severity: Optional[Union[str, Severity]] = None,
state: Optional[Union[str, AlertRuleState]] = None,
alert_rule_name: Optional[str] = None,
description: Optional[str] = None,
location: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
throttling: Optional[ThrottlingInformationArgs] = None)
func NewSmartDetectorAlertRule(ctx *Context, name string, args SmartDetectorAlertRuleArgs, opts ...ResourceOption) (*SmartDetectorAlertRule, error)
public SmartDetectorAlertRule(string name, SmartDetectorAlertRuleArgs args, CustomResourceOptions? opts = null)
public SmartDetectorAlertRule(String name, SmartDetectorAlertRuleArgs args)
public SmartDetectorAlertRule(String name, SmartDetectorAlertRuleArgs args, CustomResourceOptions options)
type: azure-native:alertsmanagement:SmartDetectorAlertRule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. SmartDetectorAlertRuleArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. SmartDetectorAlertRuleArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. SmartDetectorAlertRuleArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. SmartDetectorAlertRuleArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. SmartDetectorAlertRuleArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var smartDetectorAlertRuleResource = new AzureNative.Alertsmanagement.SmartDetectorAlertRule("smartDetectorAlertRuleResource", new()
{
ActionGroups =
{
{ "groupIds", new[]
{
"string",
} },
{ "customEmailSubject", "string" },
{ "customWebhookPayload", "string" },
},
Detector =
{
{ "id", "string" },
{ "parameters",
{
{ "string", "any" },
} },
},
Frequency = "string",
ResourceGroupName = "string",
Scope = new[]
{
"string",
},
Severity = "string",
State = "string",
AlertRuleName = "string",
Description = "string",
Location = "string",
Tags =
{
{ "string", "string" },
},
Throttling =
{
{ "duration", "string" },
},
});
example, err := alertsmanagement.NewSmartDetectorAlertRule(ctx, "smartDetectorAlertRuleResource", &alertsmanagement.SmartDetectorAlertRuleArgs{
ActionGroups: map[string]interface{}{
"groupIds": []string{
"string",
},
"customEmailSubject": "string",
"customWebhookPayload": "string",
},
Detector: map[string]interface{}{
"id": "string",
"parameters": map[string]interface{}{
"string": "any",
},
},
Frequency: "string",
ResourceGroupName: "string",
Scope: []string{
"string",
},
Severity: "string",
State: "string",
AlertRuleName: "string",
Description: "string",
Location: "string",
Tags: map[string]interface{}{
"string": "string",
},
Throttling: map[string]interface{}{
"duration": "string",
},
})
var smartDetectorAlertRuleResource = new SmartDetectorAlertRule("smartDetectorAlertRuleResource", SmartDetectorAlertRuleArgs.builder()
.actionGroups(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.detector(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.frequency("string")
.resourceGroupName("string")
.scope("string")
.severity("string")
.state("string")
.alertRuleName("string")
.description("string")
.location("string")
.tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.throttling(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build());
smart_detector_alert_rule_resource = azure_native.alertsmanagement.SmartDetectorAlertRule("smartDetectorAlertRuleResource",
action_groups={
groupIds: [string],
customEmailSubject: string,
customWebhookPayload: string,
},
detector={
id: string,
parameters: {
string: any,
},
},
frequency=string,
resource_group_name=string,
scope=[string],
severity=string,
state=string,
alert_rule_name=string,
description=string,
location=string,
tags={
string: string,
},
throttling={
duration: string,
})
const smartDetectorAlertRuleResource = new azure_native.alertsmanagement.SmartDetectorAlertRule("smartDetectorAlertRuleResource", {
actionGroups: {
groupIds: ["string"],
customEmailSubject: "string",
customWebhookPayload: "string",
},
detector: {
id: "string",
parameters: {
string: "any",
},
},
frequency: "string",
resourceGroupName: "string",
scope: ["string"],
severity: "string",
state: "string",
alertRuleName: "string",
description: "string",
location: "string",
tags: {
string: "string",
},
throttling: {
duration: "string",
},
});
type: azure-native:alertsmanagement:SmartDetectorAlertRule
properties:
actionGroups:
customEmailSubject: string
customWebhookPayload: string
groupIds:
- string
alertRuleName: string
description: string
detector:
id: string
parameters:
string: any
frequency: string
location: string
resourceGroupName: string
scope:
- string
severity: string
state: string
tags:
string: string
throttling:
duration: string
SmartDetectorAlertRule Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SmartDetectorAlertRule resource accepts the following input properties:
- Action
Groups This property is required. Pulumi.Azure Native. Alerts Management. Inputs. Action Groups Information - The alert rule actions.
- Detector
This property is required. Pulumi.Azure Native. Alerts Management. Inputs. Detector - The alert rule's detector.
- Frequency
This property is required. 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.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- Scope
This property is required. List<string> - The alert rule resources scope.
- Severity
This property is required. string | Pulumi.Azure Native. Alerts Management. Severity - The alert rule severity.
- State
This property is required. string | Pulumi.Azure Native. Alerts Management. Alert Rule State - The alert rule state.
- Alert
Rule Name Changes to this property will trigger replacement.
- The name of the alert rule.
- Description string
- The alert rule description.
- Location string
- The resource location.
- Dictionary<string, string>
- The resource tags.
- Throttling
Pulumi.
Azure Native. Alerts Management. Inputs. Throttling Information - The alert rule throttling information.
- Action
Groups This property is required. ActionGroups Information Args - The alert rule actions.
- Detector
This property is required. DetectorArgs - The alert rule's detector.
- Frequency
This property is required. 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.
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- Scope
This property is required. []string - The alert rule resources scope.
- Severity
This property is required. string | Severity - The alert rule severity.
- State
This property is required. string | AlertRule State - The alert rule state.
- Alert
Rule Name Changes to this property will trigger replacement.
- The name of the alert rule.
- Description string
- The alert rule description.
- Location string
- The resource location.
- map[string]string
- The resource tags.
- Throttling
Throttling
Information Args - The alert rule throttling information.
- action
Groups This property is required. ActionGroups Information - The alert rule actions.
- detector
This property is required. Detector - The alert rule's detector.
- frequency
This property is required. 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.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- scope
This property is required. List<String> - The alert rule resources scope.
- severity
This property is required. String | Severity - The alert rule severity.
- state
This property is required. String | AlertRule State - The alert rule state.
- alert
Rule Name Changes to this property will trigger replacement.
- The name of the alert rule.
- description String
- The alert rule description.
- location String
- The resource location.
- Map<String,String>
- The resource tags.
- throttling
Throttling
Information - The alert rule throttling information.
- action
Groups This property is required. ActionGroups Information - The alert rule actions.
- detector
This property is required. Detector - The alert rule's detector.
- frequency
This property is required. 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.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- scope
This property is required. string[] - The alert rule resources scope.
- severity
This property is required. string | Severity - The alert rule severity.
- state
This property is required. string | AlertRule State - The alert rule state.
- alert
Rule Name Changes to this property will trigger replacement.
- The name of the alert rule.
- description string
- The alert rule description.
- location string
- The resource location.
- {[key: string]: string}
- The resource tags.
- throttling
Throttling
Information - The alert rule throttling information.
- action_
groups This property is required. ActionGroups Information Args - The alert rule actions.
- detector
This property is required. DetectorArgs - The alert rule's detector.
- frequency
This property is required. 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.
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- scope
This property is required. Sequence[str] - The alert rule resources scope.
- severity
This property is required. str | Severity - The alert rule severity.
- state
This property is required. str | AlertRule State - The alert rule state.
- alert_
rule_ name Changes to this property will trigger replacement.
- The name of the alert rule.
- description str
- The alert rule description.
- location str
- The resource location.
- Mapping[str, str]
- The resource tags.
- throttling
Throttling
Information Args - The alert rule throttling information.
- action
Groups This property is required. Property Map - The alert rule actions.
- detector
This property is required. Property Map - The alert rule's detector.
- frequency
This property is required. 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.
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- The name of the resource group.
- scope
This property is required. List<String> - The alert rule resources scope.
- severity
This property is required. String | "Sev0" | "Sev1" | "Sev2" | "Sev3" | "Sev4" - The alert rule severity.
- state
This property is required. String | "Enabled" | "Disabled" - The alert rule state.
- alert
Rule Name Changes to this property will trigger replacement.
- The name of the alert rule.
- description String
- The alert rule description.
- location String
- The resource location.
- Map<String>
- The resource tags.
- throttling Property Map
- The alert rule throttling information.
Outputs
All input properties are implicitly available as output properties. Additionally, the SmartDetectorAlertRule resource produces the following output properties:
Supporting Types
ActionGroupsInformation, ActionGroupsInformationArgs
- Group
Ids This property is required. 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 This property is required. []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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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.
ActionGroupsInformationResponse, ActionGroupsInformationResponseArgs
- Group
Ids This property is required. 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 This property is required. []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 This property is required. 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 This property is required. 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 This property is required. 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 This property is required. 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.
AlertRuleState, AlertRuleStateArgs
- Enabled
- Enabled
- Disabled
- Disabled
- Alert
Rule State Enabled - Enabled
- Alert
Rule State Disabled - Disabled
- Enabled
- Enabled
- Disabled
- Disabled
- Enabled
- Enabled
- Disabled
- Disabled
- ENABLED
- Enabled
- DISABLED
- Disabled
- "Enabled"
- Enabled
- "Disabled"
- Disabled
Detector, DetectorArgs
- Id
This property is required. string - The detector id.
- Parameters Dictionary<string, object>
- The detector's parameters.'
- Id
This property is required. string - The detector id.
- Parameters map[string]interface{}
- The detector's parameters.'
- id
This property is required. String - The detector id.
- parameters Map<String,Object>
- The detector's parameters.'
- id
This property is required. string - The detector id.
- parameters {[key: string]: any}
- The detector's parameters.'
- id
This property is required. str - The detector id.
- parameters Mapping[str, Any]
- The detector's parameters.'
- id
This property is required. String - The detector id.
- parameters Map<Any>
- The detector's parameters.'
DetectorParameterDefinitionResponse, DetectorParameterDefinitionResponseArgs
- 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, DetectorResponseArgs
- Description
This property is required. string - The Smart Detector description.
- Id
This property is required. string - The detector id.
- Image
Paths This property is required. List<string> - The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector
- Name
This property is required. string - The Smart Detector name.
- Parameter
Definitions This property is required. List<Pulumi.Azure Native. Alerts Management. Inputs. Detector Parameter Definition Response> - The Smart Detector parameters definitions.'
- Supported
Cadences This property is required. List<int> - The Smart Detector supported cadences.
- Supported
Resource Types This property is required. List<string> - The Smart Detector supported resource types.
- Parameters Dictionary<string, object>
- The detector's parameters.'
- Description
This property is required. string - The Smart Detector description.
- Id
This property is required. string - The detector id.
- Image
Paths This property is required. []string - The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector
- Name
This property is required. string - The Smart Detector name.
- Parameter
Definitions This property is required. []DetectorParameter Definition Response - The Smart Detector parameters definitions.'
- Supported
Cadences This property is required. []int - The Smart Detector supported cadences.
- Supported
Resource Types This property is required. []string - The Smart Detector supported resource types.
- Parameters map[string]interface{}
- The detector's parameters.'
- description
This property is required. String - The Smart Detector description.
- id
This property is required. String - The detector id.
- image
Paths This property is required. List<String> - The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector
- name
This property is required. String - The Smart Detector name.
- parameter
Definitions This property is required. List<DetectorParameter Definition Response> - The Smart Detector parameters definitions.'
- supported
Cadences This property is required. List<Integer> - The Smart Detector supported cadences.
- supported
Resource Types This property is required. List<String> - The Smart Detector supported resource types.
- parameters Map<String,Object>
- The detector's parameters.'
- description
This property is required. string - The Smart Detector description.
- id
This property is required. string - The detector id.
- image
Paths This property is required. string[] - The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector
- name
This property is required. string - The Smart Detector name.
- parameter
Definitions This property is required. DetectorParameter Definition Response[] - The Smart Detector parameters definitions.'
- supported
Cadences This property is required. number[] - The Smart Detector supported cadences.
- supported
Resource Types This property is required. string[] - The Smart Detector supported resource types.
- parameters {[key: string]: any}
- The detector's parameters.'
- description
This property is required. str - The Smart Detector description.
- id
This property is required. str - The detector id.
- image_
paths This property is required. Sequence[str] - The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector
- name
This property is required. str - The Smart Detector name.
- parameter_
definitions This property is required. Sequence[DetectorParameter Definition Response] - The Smart Detector parameters definitions.'
- supported_
cadences This property is required. Sequence[int] - The Smart Detector supported cadences.
- supported_
resource_ types This property is required. Sequence[str] - The Smart Detector supported resource types.
- parameters Mapping[str, Any]
- The detector's parameters.'
- description
This property is required. String - The Smart Detector description.
- id
This property is required. String - The detector id.
- image
Paths This property is required. List<String> - The Smart Detector image path. By default this is not populated, unless it's specified in expandDetector
- name
This property is required. String - The Smart Detector name.
- parameter
Definitions This property is required. List<Property Map> - The Smart Detector parameters definitions.'
- supported
Cadences This property is required. List<Number> - The Smart Detector supported cadences.
- supported
Resource Types This property is required. List<String> - The Smart Detector supported resource types.
- parameters Map<Any>
- The detector's parameters.'
Severity, SeverityArgs
- Sev0
- Sev0
- Sev1
- Sev1
- Sev2
- Sev2
- Sev3
- Sev3
- Sev4
- Sev4
- Severity
Sev0 - Sev0
- Severity
Sev1 - Sev1
- Severity
Sev2 - Sev2
- Severity
Sev3 - Sev3
- Severity
Sev4 - Sev4
- Sev0
- Sev0
- Sev1
- Sev1
- Sev2
- Sev2
- Sev3
- Sev3
- Sev4
- Sev4
- Sev0
- Sev0
- Sev1
- Sev1
- Sev2
- Sev2
- Sev3
- Sev3
- Sev4
- Sev4
- SEV0
- Sev0
- SEV1
- Sev1
- SEV2
- Sev2
- SEV3
- Sev3
- SEV4
- Sev4
- "Sev0"
- Sev0
- "Sev1"
- Sev1
- "Sev2"
- Sev2
- "Sev3"
- Sev3
- "Sev4"
- Sev4
ThrottlingInformation, ThrottlingInformationArgs
- 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
ThrottlingInformationResponse, ThrottlingInformationResponseArgs
- 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
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:alertsmanagement:SmartDetectorAlertRule MyAlertRule /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.alertsManagement/smartDetectorAlertRules/{alertRuleName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v2 pulumi/pulumi-azure-native
- License
- Apache-2.0