Microsoft.Insights (stable:2015-05-01)

2025/01/17 • 3 updated methods

ProactiveDetectionConfigurations_List (updated)
Description Gets a list of ProactiveDetection configurations of an Application Insights component.
Reference Link ¶

⚶ Changes

{
  "#id": "ProactiveDetectionConfigurations_List",
  "$responses": {
    "200": {
      "$items": {
        "$properties": {
          "@added_d6947e081f9b42739bf3e9c85e6d27d5": {
            "#name": "name",
            "Description": "The rule name",
            "Required": false,
            "Type": "string"
          },
          "@added_8662404819024b12a6b55b2c882f0771": {
            "#name": "enabled",
            "Description": "A flag that indicates whether this rule is enabled by the user",
            "Required": false,
            "Type": "boolean"
          },
          "@added_0e4dcc08bbe8462c8e0355818909d75b": {
            "#name": "sendEmailsToSubscriptionOwners",
            "Description": "A flag that indicated whether notifications on this rule should be sent to subscription owners",
            "Required": false,
            "Type": "boolean"
          },
          "@added_a530c712eef548d189b5b63a9f7128e6": {
            "#name": "customEmails",
            "Description": "Custom email addresses for this rule notifications",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          },
          "@added_0fd67457d84a4c1b88a379789bb6b130": {
            "#name": "lastUpdatedTime",
            "Description": "The last time this rule was updated",
            "Required": false,
            "Type": "string"
          },
          "@added_7cda917b15ff445bb2e65bf6b02f6fc7": {
            "#name": "ruleDefinitions",
            "Description": "Static definitions of the ProactiveDetection configuration rule (same values for all components).",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "Name",
                "Description": "The rule name",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "DisplayName",
                "Description": "The rule name as it is displayed in UI",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "Description",
                "Description": "The rule description",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "HelpUrl",
                "Description": "URL which displays additional info about the proactive detection rule",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "IsHidden",
                "Description": "A flag indicating whether the rule is hidden (from the UI)",
                "Required": false,
                "Type": "boolean"
              },
              {
                "#name": "IsEnabledByDefault",
                "Description": "A flag indicating whether the rule is enabled by default",
                "Required": false,
                "Type": "boolean"
              },
              {
                "#name": "IsInPreview",
                "Description": "A flag indicating whether the rule is in preview",
                "Required": false,
                "Type": "boolean"
              },
              {
                "#name": "SupportsEmailNotifications",
                "Description": "A flag indicating whether email notifications are supported for detections for this rule",
                "Required": false,
                "Type": "boolean"
              }
            ]
          },
          "@removed_bb9e4de97edf4b0cbd52fb6bd27a07eb": {
            "#name": "Name",
            "Description": "The rule name",
            "Required": false,
            "Type": "string"
          },
          "@removed_bef0b5581e7c4ce6a89ee805763d9e51": {
            "#name": "Enabled",
            "Description": "A flag that indicates whether this rule is enabled by the user",
            "Required": false,
            "Type": "boolean"
          },
          "@removed_4197a028a96c466ea83488c97043c4a9": {
            "#name": "SendEmailsToSubscriptionOwners",
            "Description": "A flag that indicated whether notifications on this rule should be sent to subscription owners",
            "Required": false,
            "Type": "boolean"
          },
          "@removed_0db9f8ceb5bd46618b37197165d18037": {
            "#name": "CustomEmails",
            "Description": "Custom email addresses for this rule notifications",
            "Required": false,
            "Type": "array",
            "$items": {
              "Type": "string"
            }
          },
          "@removed_c076cd14419f4d0398c35942ca658aca": {
            "#name": "LastUpdatedTime",
            "Description": "The last time this rule was updated",
            "Required": false,
            "Type": "string"
          },
          "@removed_0a52b7db1bef42e6a2a486e3e2808599": {
            "#name": "RuleDefinitions",
            "Description": "Static definitions of the ProactiveDetection configuration rule (same values for all components).",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "Name",
                "Description": "The rule name",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "DisplayName",
                "Description": "The rule name as it is displayed in UI",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "Description",
                "Description": "The rule description",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "HelpUrl",
                "Description": "URL which displays additional info about the proactive detection rule",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "IsHidden",
                "Description": "A flag indicating whether the rule is hidden (from the UI)",
                "Required": false,
                "Type": "boolean"
              },
              {
                "#name": "IsEnabledByDefault",
                "Description": "A flag indicating whether the rule is enabled by default",
                "Required": false,
                "Type": "boolean"
              },
              {
                "#name": "IsInPreview",
                "Description": "A flag indicating whether the rule is in preview",
                "Required": false,
                "Type": "boolean"
              },
              {
                "#name": "SupportsEmailNotifications",
                "Description": "A flag indicating whether email notifications are supported for detections for this rule",
                "Required": false,
                "Type": "boolean"
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/ProactiveDetectionConfigs
{
resourceGroupName: string ,
api-version: string ,
subscriptionId: string ,
resourceName: string ,
}

⚐ Response (200)

{
name: string ,
enabled: boolean ,
sendEmailsToSubscriptionOwners: boolean ,
customEmails:
[
string ,
]
,
lastUpdatedTime: string ,
ruleDefinitions:
{
Name: string ,
DisplayName: string ,
Description: string ,
HelpUrl: string ,
IsHidden: boolean ,
IsEnabledByDefault: boolean ,
IsInPreview: boolean ,
SupportsEmailNotifications: boolean ,
}
,
}
ProactiveDetectionConfigurations_Get (updated)
Description Get the ProactiveDetection configuration for this configuration id.
Reference Link ¶

⚶ Changes

{
  "#id": "ProactiveDetectionConfigurations_Get",
  "$responses": {
    "200": {
      "$properties": {
        "@added_3aa49e7707c04094bc4eb35f2d4083e0": {
          "#name": "name",
          "Description": "The rule name",
          "Required": false,
          "Type": "string"
        },
        "@added_0176f34df7a54c969756d53a084f476b": {
          "#name": "enabled",
          "Description": "A flag that indicates whether this rule is enabled by the user",
          "Required": false,
          "Type": "boolean"
        },
        "@added_749040de850141d59199325b110a640d": {
          "#name": "sendEmailsToSubscriptionOwners",
          "Description": "A flag that indicated whether notifications on this rule should be sent to subscription owners",
          "Required": false,
          "Type": "boolean"
        },
        "@added_67a793eadc364bb084dee05e96e8d14c": {
          "#name": "customEmails",
          "Description": "Custom email addresses for this rule notifications",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        },
        "@added_f6a0fc5576d8438abfba921f9ccfe309": {
          "#name": "lastUpdatedTime",
          "Description": "The last time this rule was updated",
          "Required": false,
          "Type": "string"
        },
        "@added_c3d2d1ebd544485f8634b233dca0aed0": {
          "#name": "ruleDefinitions",
          "Description": "Static definitions of the ProactiveDetection configuration rule (same values for all components).",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "Name",
              "Description": "The rule name",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "DisplayName",
              "Description": "The rule name as it is displayed in UI",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "Description",
              "Description": "The rule description",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "HelpUrl",
              "Description": "URL which displays additional info about the proactive detection rule",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "IsHidden",
              "Description": "A flag indicating whether the rule is hidden (from the UI)",
              "Required": false,
              "Type": "boolean"
            },
            {
              "#name": "IsEnabledByDefault",
              "Description": "A flag indicating whether the rule is enabled by default",
              "Required": false,
              "Type": "boolean"
            },
            {
              "#name": "IsInPreview",
              "Description": "A flag indicating whether the rule is in preview",
              "Required": false,
              "Type": "boolean"
            },
            {
              "#name": "SupportsEmailNotifications",
              "Description": "A flag indicating whether email notifications are supported for detections for this rule",
              "Required": false,
              "Type": "boolean"
            }
          ]
        },
        "@removed_f65eb2e6a54b4660a91787704253d485": {
          "#name": "Name",
          "Description": "The rule name",
          "Required": false,
          "Type": "string"
        },
        "@removed_3ff52944c60f4b87ac10790922a47dc6": {
          "#name": "Enabled",
          "Description": "A flag that indicates whether this rule is enabled by the user",
          "Required": false,
          "Type": "boolean"
        },
        "@removed_7b23992c69974cd6a4596ee89dbdc589": {
          "#name": "SendEmailsToSubscriptionOwners",
          "Description": "A flag that indicated whether notifications on this rule should be sent to subscription owners",
          "Required": false,
          "Type": "boolean"
        },
        "@removed_203f42ad6dd84cf0b3b818c0d02b4f02": {
          "#name": "CustomEmails",
          "Description": "Custom email addresses for this rule notifications",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        },
        "@removed_b1e7b4818ba34d8ca73716d59eb3c7a6": {
          "#name": "LastUpdatedTime",
          "Description": "The last time this rule was updated",
          "Required": false,
          "Type": "string"
        },
        "@removed_d30f56e2620c48f088e19bb3aed55fbd": {
          "#name": "RuleDefinitions",
          "Description": "Static definitions of the ProactiveDetection configuration rule (same values for all components).",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "Name",
              "Description": "The rule name",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "DisplayName",
              "Description": "The rule name as it is displayed in UI",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "Description",
              "Description": "The rule description",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "HelpUrl",
              "Description": "URL which displays additional info about the proactive detection rule",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "IsHidden",
              "Description": "A flag indicating whether the rule is hidden (from the UI)",
              "Required": false,
              "Type": "boolean"
            },
            {
              "#name": "IsEnabledByDefault",
              "Description": "A flag indicating whether the rule is enabled by default",
              "Required": false,
              "Type": "boolean"
            },
            {
              "#name": "IsInPreview",
              "Description": "A flag indicating whether the rule is in preview",
              "Required": false,
              "Type": "boolean"
            },
            {
              "#name": "SupportsEmailNotifications",
              "Description": "A flag indicating whether email notifications are supported for detections for this rule",
              "Required": false,
              "Type": "boolean"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/ProactiveDetectionConfigs/{ConfigurationId}
{
resourceGroupName: string ,
api-version: string ,
subscriptionId: string ,
resourceName: string ,
ConfigurationId: string ,
}

⚐ Response (200)

{
name: string ,
enabled: boolean ,
sendEmailsToSubscriptionOwners: boolean ,
customEmails:
[
string ,
]
,
lastUpdatedTime: string ,
ruleDefinitions:
{
Name: string ,
DisplayName: string ,
Description: string ,
HelpUrl: string ,
IsHidden: boolean ,
IsEnabledByDefault: boolean ,
IsInPreview: boolean ,
SupportsEmailNotifications: boolean ,
}
,
}
ProactiveDetectionConfigurations_Update (updated)
Description Update the ProactiveDetection configuration for this configuration id.
Reference Link ¶

⚶ Changes

{
  "#id": "ProactiveDetectionConfigurations_Update",
  "$parameters": {
    "ProactiveDetectionProperties": {
      "$properties": {
        "@added_cb23aa202a1449919bed862c842be980": {
          "#name": "name",
          "Description": "The rule name",
          "Required": false,
          "Type": "string"
        },
        "@added_5b48ddf40bea405f8a30c14d9242d5c4": {
          "#name": "enabled",
          "Description": "A flag that indicates whether this rule is enabled by the user",
          "Required": false,
          "Type": "boolean"
        },
        "@added_03807b51d2a9490ba44685d638029036": {
          "#name": "sendEmailsToSubscriptionOwners",
          "Description": "A flag that indicated whether notifications on this rule should be sent to subscription owners",
          "Required": false,
          "Type": "boolean"
        },
        "@added_a515d83860d3481f8974bae04f811c28": {
          "#name": "customEmails",
          "Description": "Custom email addresses for this rule notifications",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        },
        "@added_b1b9ae41eaed477ca1f8c600bdb671c4": {
          "#name": "lastUpdatedTime",
          "Description": "The last time this rule was updated",
          "Required": false,
          "Type": "string"
        },
        "@added_72241fc9e45a4a57bf1c050edde8e91e": {
          "#name": "ruleDefinitions",
          "Description": "Static definitions of the ProactiveDetection configuration rule (same values for all components).",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "Name",
              "Description": "The rule name",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "DisplayName",
              "Description": "The rule name as it is displayed in UI",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "Description",
              "Description": "The rule description",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "HelpUrl",
              "Description": "URL which displays additional info about the proactive detection rule",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "IsHidden",
              "Description": "A flag indicating whether the rule is hidden (from the UI)",
              "Required": false,
              "Type": "boolean"
            },
            {
              "#name": "IsEnabledByDefault",
              "Description": "A flag indicating whether the rule is enabled by default",
              "Required": false,
              "Type": "boolean"
            },
            {
              "#name": "IsInPreview",
              "Description": "A flag indicating whether the rule is in preview",
              "Required": false,
              "Type": "boolean"
            },
            {
              "#name": "SupportsEmailNotifications",
              "Description": "A flag indicating whether email notifications are supported for detections for this rule",
              "Required": false,
              "Type": "boolean"
            }
          ]
        },
        "@removed_ce2958464d7647638ebd40b9ee4612c1": {
          "#name": "Name",
          "Description": "The rule name",
          "Required": false,
          "Type": "string"
        },
        "@removed_642b8d92b6e5425ab45ea42a570d3762": {
          "#name": "Enabled",
          "Description": "A flag that indicates whether this rule is enabled by the user",
          "Required": false,
          "Type": "boolean"
        },
        "@removed_437b6627fc5745e3b961aca7eb2d193b": {
          "#name": "SendEmailsToSubscriptionOwners",
          "Description": "A flag that indicated whether notifications on this rule should be sent to subscription owners",
          "Required": false,
          "Type": "boolean"
        },
        "@removed_c83b3b77ba064599852d5ca96fbaabbe": {
          "#name": "CustomEmails",
          "Description": "Custom email addresses for this rule notifications",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        },
        "@removed_b2fdb1505035419eb2ea568f8bdb79a0": {
          "#name": "LastUpdatedTime",
          "Description": "The last time this rule was updated",
          "Required": false,
          "Type": "string"
        },
        "@removed_10d9ea71bcd1494dbb878596bf97e519": {
          "#name": "RuleDefinitions",
          "Description": "Static definitions of the ProactiveDetection configuration rule (same values for all components).",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "Name",
              "Description": "The rule name",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "DisplayName",
              "Description": "The rule name as it is displayed in UI",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "Description",
              "Description": "The rule description",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "HelpUrl",
              "Description": "URL which displays additional info about the proactive detection rule",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "IsHidden",
              "Description": "A flag indicating whether the rule is hidden (from the UI)",
              "Required": false,
              "Type": "boolean"
            },
            {
              "#name": "IsEnabledByDefault",
              "Description": "A flag indicating whether the rule is enabled by default",
              "Required": false,
              "Type": "boolean"
            },
            {
              "#name": "IsInPreview",
              "Description": "A flag indicating whether the rule is in preview",
              "Required": false,
              "Type": "boolean"
            },
            {
              "#name": "SupportsEmailNotifications",
              "Description": "A flag indicating whether email notifications are supported for detections for this rule",
              "Required": false,
              "Type": "boolean"
            }
          ]
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "@added_0fc20e02bd0f4ded980cc4f8d283dbcc": {
          "#name": "name",
          "Description": "The rule name",
          "Required": false,
          "Type": "string"
        },
        "@added_0208de65e15c4cc3a427f1edc07df6b7": {
          "#name": "enabled",
          "Description": "A flag that indicates whether this rule is enabled by the user",
          "Required": false,
          "Type": "boolean"
        },
        "@added_46c3e2fdcbd14490a7668af1b377cd17": {
          "#name": "sendEmailsToSubscriptionOwners",
          "Description": "A flag that indicated whether notifications on this rule should be sent to subscription owners",
          "Required": false,
          "Type": "boolean"
        },
        "@added_a6c88c99e78840148ba89c6995e0394a": {
          "#name": "customEmails",
          "Description": "Custom email addresses for this rule notifications",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        },
        "@added_f5ae6ad3b10345488aebe09eff302e86": {
          "#name": "lastUpdatedTime",
          "Description": "The last time this rule was updated",
          "Required": false,
          "Type": "string"
        },
        "@added_3c2b053ee9fe429e8ed442a78994d57b": {
          "#name": "ruleDefinitions",
          "Description": "Static definitions of the ProactiveDetection configuration rule (same values for all components).",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "Name",
              "Description": "The rule name",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "DisplayName",
              "Description": "The rule name as it is displayed in UI",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "Description",
              "Description": "The rule description",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "HelpUrl",
              "Description": "URL which displays additional info about the proactive detection rule",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "IsHidden",
              "Description": "A flag indicating whether the rule is hidden (from the UI)",
              "Required": false,
              "Type": "boolean"
            },
            {
              "#name": "IsEnabledByDefault",
              "Description": "A flag indicating whether the rule is enabled by default",
              "Required": false,
              "Type": "boolean"
            },
            {
              "#name": "IsInPreview",
              "Description": "A flag indicating whether the rule is in preview",
              "Required": false,
              "Type": "boolean"
            },
            {
              "#name": "SupportsEmailNotifications",
              "Description": "A flag indicating whether email notifications are supported for detections for this rule",
              "Required": false,
              "Type": "boolean"
            }
          ]
        },
        "@removed_a3cc178c9be44da9bc7425b4a6cf8040": {
          "#name": "Name",
          "Description": "The rule name",
          "Required": false,
          "Type": "string"
        },
        "@removed_2e5265659b684211be3564af574c939b": {
          "#name": "Enabled",
          "Description": "A flag that indicates whether this rule is enabled by the user",
          "Required": false,
          "Type": "boolean"
        },
        "@removed_90087f388ddd48eaa1d9a7c3d3ec120a": {
          "#name": "SendEmailsToSubscriptionOwners",
          "Description": "A flag that indicated whether notifications on this rule should be sent to subscription owners",
          "Required": false,
          "Type": "boolean"
        },
        "@removed_6fd5cc27bc1947c383e2269720126ee6": {
          "#name": "CustomEmails",
          "Description": "Custom email addresses for this rule notifications",
          "Required": false,
          "Type": "array",
          "$items": {
            "Type": "string"
          }
        },
        "@removed_4383e376e7f04400817bd0b5dfab3b6f": {
          "#name": "LastUpdatedTime",
          "Description": "The last time this rule was updated",
          "Required": false,
          "Type": "string"
        },
        "@removed_ac26aa6321104afaa3bd1b19a07ee00a": {
          "#name": "RuleDefinitions",
          "Description": "Static definitions of the ProactiveDetection configuration rule (same values for all components).",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "Name",
              "Description": "The rule name",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "DisplayName",
              "Description": "The rule name as it is displayed in UI",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "Description",
              "Description": "The rule description",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "HelpUrl",
              "Description": "URL which displays additional info about the proactive detection rule",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "IsHidden",
              "Description": "A flag indicating whether the rule is hidden (from the UI)",
              "Required": false,
              "Type": "boolean"
            },
            {
              "#name": "IsEnabledByDefault",
              "Description": "A flag indicating whether the rule is enabled by default",
              "Required": false,
              "Type": "boolean"
            },
            {
              "#name": "IsInPreview",
              "Description": "A flag indicating whether the rule is in preview",
              "Required": false,
              "Type": "boolean"
            },
            {
              "#name": "SupportsEmailNotifications",
              "Description": "A flag indicating whether email notifications are supported for detections for this rule",
              "Required": false,
              "Type": "boolean"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/components/{resourceName}/ProactiveDetectionConfigs/{ConfigurationId}
{
resourceGroupName: string ,
api-version: string ,
subscriptionId: string ,
resourceName: string ,
ConfigurationId: string ,
ProactiveDetectionProperties:
{
name: string ,
enabled: boolean ,
sendEmailsToSubscriptionOwners: boolean ,
customEmails:
[
string ,
]
,
lastUpdatedTime: string ,
ruleDefinitions:
{
Name: string ,
DisplayName: string ,
Description: string ,
HelpUrl: string ,
IsHidden: boolean ,
IsEnabledByDefault: boolean ,
IsInPreview: boolean ,
SupportsEmailNotifications: boolean ,
}
,
}
,
}

⚐ Response (200)

{
name: string ,
enabled: boolean ,
sendEmailsToSubscriptionOwners: boolean ,
customEmails:
[
string ,
]
,
lastUpdatedTime: string ,
ruleDefinitions:
{
Name: string ,
DisplayName: string ,
Description: string ,
HelpUrl: string ,
IsHidden: boolean ,
IsEnabledByDefault: boolean ,
IsInPreview: boolean ,
SupportsEmailNotifications: boolean ,
}
,
}