Share via

Microsoft.Insights components/ProactiveDetectionConfigs 2018-05-01-preview

Bicep resource definition

The components/ProactiveDetectionConfigs resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Insights/components/ProactiveDetectionConfigs resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Insights/components/ProactiveDetectionConfigs@2018-05-01-preview' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    customEmails: [
      'string'
    ]
    enabled: bool
    ruleDefinitions: {
      Description: 'string'
      DisplayName: 'string'
      HelpUrl: 'string'
      IsEnabledByDefault: bool
      IsHidden: bool
      IsInPreview: bool
      Name: 'string'
      SupportsEmailNotifications: bool
    }
    sendEmailsToSubscriptionOwners: bool
  }
}

Property Values

Microsoft.Insights/components/ProactiveDetectionConfigs

Name Description Value
location Resource location string
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: components
properties Properties that define a ProactiveDetection configuration. ApplicationInsightsComponentProactiveDetectionConfigurationProperties

ApplicationInsightsComponentProactiveDetectionConfigurationProperties

Name Description Value
customEmails Custom email addresses for this rule notifications string[]
enabled A flag that indicates whether this rule is enabled by the user bool
ruleDefinitions Static definitions of the ProactiveDetection configuration rule (same values for all components). ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesRuleDefinitions
sendEmailsToSubscriptionOwners A flag that indicated whether notifications on this rule should be sent to subscription owners bool

ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesRuleDefinitions

Name Description Value
Description The rule description string
DisplayName The rule name as it is displayed in UI string
HelpUrl URL which displays additional info about the proactive detection rule string
IsEnabledByDefault A flag indicating whether the rule is enabled by default bool
IsHidden A flag indicating whether the rule is hidden (from the UI) bool
IsInPreview A flag indicating whether the rule is in preview bool
Name The rule name string
SupportsEmailNotifications A flag indicating whether email notifications are supported for detections for this rule bool

ARM template resource definition

The components/ProactiveDetectionConfigs resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Insights/components/ProactiveDetectionConfigs resource, add the following JSON to your template.

{
  "type": "Microsoft.Insights/components/ProactiveDetectionConfigs",
  "apiVersion": "2018-05-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "customEmails": [ "string" ],
    "enabled": "bool",
    "ruleDefinitions": {
      "Description": "string",
      "DisplayName": "string",
      "HelpUrl": "string",
      "IsEnabledByDefault": "bool",
      "IsHidden": "bool",
      "IsInPreview": "bool",
      "Name": "string",
      "SupportsEmailNotifications": "bool"
    },
    "sendEmailsToSubscriptionOwners": "bool"
  }
}

Property Values

Microsoft.Insights/components/ProactiveDetectionConfigs

Name Description Value
apiVersion The api version '2018-05-01-preview'
location Resource location string
name The resource name string (required)
properties Properties that define a ProactiveDetection configuration. ApplicationInsightsComponentProactiveDetectionConfigurationProperties
type The resource type 'Microsoft.Insights/components/ProactiveDetectionConfigs'

ApplicationInsightsComponentProactiveDetectionConfigurationProperties

Name Description Value
customEmails Custom email addresses for this rule notifications string[]
enabled A flag that indicates whether this rule is enabled by the user bool
ruleDefinitions Static definitions of the ProactiveDetection configuration rule (same values for all components). ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesRuleDefinitions
sendEmailsToSubscriptionOwners A flag that indicated whether notifications on this rule should be sent to subscription owners bool

ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesRuleDefinitions

Name Description Value
Description The rule description string
DisplayName The rule name as it is displayed in UI string
HelpUrl URL which displays additional info about the proactive detection rule string
IsEnabledByDefault A flag indicating whether the rule is enabled by default bool
IsHidden A flag indicating whether the rule is hidden (from the UI) bool
IsInPreview A flag indicating whether the rule is in preview bool
Name The rule name string
SupportsEmailNotifications A flag indicating whether email notifications are supported for detections for this rule bool

Usage Examples

Terraform (AzAPI provider) resource definition

The components/ProactiveDetectionConfigs resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Insights/components/ProactiveDetectionConfigs resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/components/ProactiveDetectionConfigs@2018-05-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  body = {
    properties = {
      customEmails = [
        "string"
      ]
      enabled = bool
      ruleDefinitions = {
        Description = "string"
        DisplayName = "string"
        HelpUrl = "string"
        IsEnabledByDefault = bool
        IsHidden = bool
        IsInPreview = bool
        Name = "string"
        SupportsEmailNotifications = bool
      }
      sendEmailsToSubscriptionOwners = bool
    }
  }
}

Property Values

Microsoft.Insights/components/ProactiveDetectionConfigs

Name Description Value
location Resource location string
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: components
properties Properties that define a ProactiveDetection configuration. ApplicationInsightsComponentProactiveDetectionConfigurationProperties
type The resource type "Microsoft.Insights/components/ProactiveDetectionConfigs@2018-05-01-preview"

ApplicationInsightsComponentProactiveDetectionConfigurationProperties

Name Description Value
customEmails Custom email addresses for this rule notifications string[]
enabled A flag that indicates whether this rule is enabled by the user bool
ruleDefinitions Static definitions of the ProactiveDetection configuration rule (same values for all components). ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesRuleDefinitions
sendEmailsToSubscriptionOwners A flag that indicated whether notifications on this rule should be sent to subscription owners bool

ApplicationInsightsComponentProactiveDetectionConfigurationPropertiesRuleDefinitions

Name Description Value
Description The rule description string
DisplayName The rule name as it is displayed in UI string
HelpUrl URL which displays additional info about the proactive detection rule string
IsEnabledByDefault A flag indicating whether the rule is enabled by default bool
IsHidden A flag indicating whether the rule is hidden (from the UI) bool
IsInPreview A flag indicating whether the rule is in preview bool
Name The rule name string
SupportsEmailNotifications A flag indicating whether email notifications are supported for detections for this rule bool