Microsoft.Insights metricAlerts 2018-03-01
Bicep リソース定義
metricAlerts リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
注釈
監視ソリューションのデプロイに関するガイダンスについては、「 Bicep を使用して監視リソースを作成する」を参照してください。
リソース形式
Microsoft.Insights/metricAlerts リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Insights/metricAlerts@2018-03-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
properties: {
actions: [
{
actionGroupId: 'string'
webHookProperties: {}
}
]
autoMitigate: bool
criteria: {
'odata.type': 'string'
// For remaining properties, see MetricAlertCriteria objects
}
description: 'string'
enabled: bool
evaluationFrequency: 'string'
scopes: [
'string'
]
severity: int
targetResourceRegion: 'string'
targetResourceType: 'string'
windowSize: 'string'
}
}
MetricAlertCriteria オブジェクト
オブジェクトの種類を指定するには 、odata.type プロパティを設定します。
Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria の場合は、次の値を使用します。
'odata.type': 'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria'
allOf: [
{
dimensions: [
{
name: 'string'
operator: 'string'
values: [
'string'
]
}
]
metricName: 'string'
metricNamespace: 'string'
name: 'string'
skipMetricValidation: bool
timeAggregation: 'string'
criterionType: 'string'
// For remaining properties, see MultiMetricCriteria objects
}
]
Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria の場合は、次の値を使用します。
'odata.type': 'Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria'
allOf: [
{
criterionType: 'string'
dimensions: [
{
name: 'string'
operator: 'string'
values: [
'string'
]
}
]
metricName: 'string'
metricNamespace: 'string'
name: 'string'
operator: 'string'
skipMetricValidation: bool
threshold: int
timeAggregation: 'string'
}
]
Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria の場合は、次の値を使用します。
'odata.type': 'Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria'
componentId: 'string'
failedLocationCount: int
webTestId: 'string'
MultiMetricCriteria オブジェクト
オブジェクトの種類を指定するには、 criterionType プロパティを設定します。
DynamicThresholdCriterion の場合は、次の値を使用します。
criterionType: 'DynamicThresholdCriterion'
alertSensitivity: 'string'
failingPeriods: {
minFailingPeriodsToAlert: int
numberOfEvaluationPeriods: int
}
ignoreDataBefore: 'string'
operator: 'string'
StaticThresholdCriterion の場合は、次の値を使用します。
criterionType: 'StaticThresholdCriterion'
operator: 'string'
threshold: int
プロパティ値
metricAlerts
名前 | 説明 | 値 |
---|---|---|
name | リソース名 | string (必須) 文字数制限: 1 から 260 有効な文字: 次は使用できません: 末尾をスペースまたはピリオドにすることはできません。 |
location | リソースの場所 | string (必須) |
tags | リソース タグ | タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください |
properties | リソースのアラート ルールのプロパティ。 | MetricAlertProperties (必須) |
MetricAlertProperties
名前 | 説明 | 値 |
---|---|---|
actions | アラート ルールがアクティブになったとき、およびアラート条件が解決されたときに実行されるアクションの配列。 | MetricAlertAction[] |
autoMitigate | アラートを自動解決するかどうかを示す フラグ。 既定値は true です。 | [bool] |
条件 | は、特定のアラート条件情報を定義します。 | MetricAlertCriteria (必須) |
description | アラート メールに含まれるメトリック アラートの説明。 | string |
enabled | メトリック アラートが有効になっているかどうかを示すフラグ。 | bool (必須) |
evaluationFrequency | メトリック アラートが評価される頻度は、ISO 8601 期間形式で表されます。 | string (必須) |
スコープ | このメトリック アラートのスコープが設定されているリソース ID の一覧。 | string[] (必須) |
severity | アラートの重大度 {0、1、2、3、4} | int (必須) |
targetResourceRegion | アラートが作成または更新されるターゲット リソースのリージョン。 スコープにサブスクリプション、リソース グループ、または複数のリソースが含まれている場合は必須です。 | string |
targetResourceType | アラートが作成または更新されるターゲット リソースのリソースの種類。 スコープにサブスクリプション、リソース グループ、または複数のリソースが含まれている場合は必須です。 | string |
windowSize | しきい値に基づいてアラート アクティビティを監視するために使用される期間 (ISO 8601 期間形式)。 | string (必須) |
MetricAlertAction
名前 | 説明 | 値 |
---|---|---|
actionGroupId | 使用するアクション グループの ID。 | string |
webHookProperties | このフィールドでは、Webhook への入力として送信されるアラート ペイロードに追加されるカスタム プロパティを指定できます。 | object |
MetricAlertCriteria
MetricAlertMultipleResourceMultipleMetricCriteria
名前 | 説明 | 値 |
---|---|---|
odata.type | は、アラート条件の種類を指定します。 | 'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria' (必須) |
allOf | この 'all of' 操作の複数のメトリック条件の一覧。 | MultiMetricCriteria[] |
MultiMetricCriteria
名前 | 説明 | 値 |
---|---|---|
dimensions | ディメンション条件の一覧。 | MetricDimension[] |
metricName | メトリックの名前。 | string (必須) |
metricNamespace | メトリックの名前空間。 | string |
name | 条件の名前。 | string (必須) |
skipMetricValidation | メトリック検証をスキップすることによって、まだ出力されていないカスタム メトリックに対するアラート ルールの作成を許可します。 | [bool] |
timeAggregation | 条件の時間集計の種類。 | 'Average' 'Count' 'Maximum' 'Minimum' 'Total' (必須) |
criterionType | オブジェクトの種類を設定する | DynamicThresholdCriterion StaticThresholdCriterion (必須) |
MetricDimension
名前 | 説明 | 値 |
---|---|---|
name | ディメンションの名前。 | string (必須) |
operator | ディメンション演算子。 'Include' と 'Exclude' のみがサポートされています | string (必須) |
値 | ディメンション値の一覧。 | string[] (必須) |
DynamicMetricCriteria
名前 | 説明 | 値 |
---|---|---|
criterionType | しきい値の条件の種類を指定します | 'DynamicThresholdCriterion' (必須) |
alertSensitivity | アラートをトリガーするために必要な偏差の範囲。 これは、メトリック系列パターンに対するしきい値の厳しい程度に影響します。 | 'High' 'Low' 'Medium' (必須) |
failingPeriods | アラートの発生に必要な、選択したルックバック時間枠内で必要な違反の最小数。 | DynamicThresholdFailingPeriods (必須) |
ignoreDataBefore | このオプションを使用して、メトリック履歴データの学習を開始する日付を設定し、動的しきい値を計算する (ISO8601形式) | string |
operator | メトリック値としきい値の比較に使用される演算子。 | 'GreaterOrLessThan' 'GreaterThan' 'LessThan' (必須) |
DynamicThresholdFailingPeriods
名前 | 説明 | 値 |
---|---|---|
minFailingPeriodsToAlert | アラートをトリガーする違反の数。 numberOfEvaluationPeriods 以下にする必要があります。 | int (必須) |
numberOfEvaluationPeriods | 集計されたルックバック ポイントの数。 ルックバック タイム ウィンドウは、集計粒度 (windowSize) と、選択した集計ポイント数に基づいて計算されます。 | int (必須) |
MetricCriteria
名前 | 説明 | 値 |
---|---|---|
criterionType | しきい値条件の種類を指定します | 'DynamicThresholdCriterion' 'StaticThresholdCriterion' (必須) |
dimensions | ディメンション条件の一覧。 | MetricDimension[] |
metricName | メトリックの名前。 | string (必須) |
metricNamespace | メトリックの名前空間。 | string |
name | 条件の名前。 | string (必須) |
operator | criteria 演算子。 | 'Equals' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (必須) |
skipMetricValidation | メトリック検証をスキップすることによって、まだ出力されていないカスタム メトリックに対するアラート ルールの作成を許可します。 | [bool] |
threshold | アラートをアクティブにする条件しきい値。 | int (必須) |
timeAggregation | 条件の時間集計の種類。 | 'Average' 'Count' 'Maximum' 'Minimum' 'Total' (必須) |
MetricAlertSingleResourceMultipleMetricCriteria
名前 | 説明 | 値 |
---|---|---|
odata.type | は、アラート条件の種類を指定します。 | 'Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria' (必須) |
allOf | この "all of" 操作のメトリック条件の一覧。 | MetricCriteria[] |
WebtestLocationAvailabilityCriteria
名前 | 説明 | 値 |
---|---|---|
odata.type | は、アラート条件の種類を指定します。 | 'Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria' (必須) |
componentId | Application Insights リソース ID。 | string (必須) |
failedLocationCount | 失敗した場所の数。 | int (必須) |
webTestId | Application Insights Web テスト ID。 | string (必須) |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
Template | 説明 |
---|---|
BrowserBox Azure Edition |
このテンプレートは、Azure Ubuntu Server 22.04 LTS、Debian 11、または RHEL 8.7 LVM VM に BrowserBox をデプロイします。 |
スケーラブルな Umbraco CMS Web アプリ |
このテンプレートは、umbraco CMS Web アプリをAzure App Service Web Appsに簡単にデプロイする方法を提供します。 |
Application Gatewayのアラートを作成する |
これらのテンプレートを使用して、Azure Application Gatewayの重要なイベント アラートを簡単に作成できます。 |
バックエンドの最後のバイト応答メトリックのアラート |
このようなテンプレートを使用して、Azure Application Gatewayの重要なイベント アラートを簡単に作成できます。 |
異常なホスト数メトリックのアラート |
このようなテンプレートを使用して、Azure Application Gatewayの重要なイベント アラートを簡単に作成できます。 |
Enterprise Governance-AppService、SQL DB、AD、OMS、Runbook |
小規模または大規模なエンタープライズ向けのクラウド導入では、クラウド デプロイから価値を引き出すために、責任ある効率的なガバナンス モデルが必要です。 CloudWise (ソリューションのコード名) は、Azure Partner QuickStarts から入手できる複合ソリューションであり、顧客、システム インテグレーター、パートナーの導入を可能にする企業であり、コストの最適化、アプリケーションの信頼性の向上、ビジネス リスクの削減に重点を置いた、セルフサービスで自動化されたガバナンスと運用ソリューションを提供します。 このソリューションでは、可視性と制御の主要なガバナンスの柱が強調されています。 |
動的 Web テストの作成 |
任意の数の App Insights Web (ping) テストを作成します。 |
Application Insight をデプロイし、アラートを作成する |
このテンプレートを使用すると、Application Insight をデプロイし、その中にアラートを作成できます |
動的しきい値を持つメトリック アラート ルール |
このテンプレートでは、動的しきい値条件の種類を使用して仮想マシンの CPU 使用率メトリックを監視するメトリック アラート ルールを作成します。 |
静的しきい値を持つメトリック アラート ルール |
このテンプレートでは、静的しきい値条件の種類を使用して仮想マシンの CPU 使用率メトリックを監視するメトリック アラート ルールを作成します。 |
可用性テストのメトリック アラート ルール |
このテンプレートは、Application Insights 可用性テストと、それを監視するメトリック アラート ルールを作成します。 |
ARM テンプレート リソース定義
metricAlerts リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
注釈
監視ソリューションのデプロイに関するガイダンスについては、「 Bicep を使用して監視リソースを作成する」を参照してください。
リソース形式
Microsoft.Insights/metricAlerts リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Insights/metricAlerts",
"apiVersion": "2018-03-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"properties": {
"actions": [
{
"actionGroupId": "string",
"webHookProperties": {}
}
],
"autoMitigate": "bool",
"criteria": {
"odata.type": "string"
// For remaining properties, see MetricAlertCriteria objects
},
"description": "string",
"enabled": "bool",
"evaluationFrequency": "string",
"scopes": [ "string" ],
"severity": "int",
"targetResourceRegion": "string",
"targetResourceType": "string",
"windowSize": "string"
}
}
MetricAlertCriteria オブジェクト
オブジェクトの種類を指定するには、 odata.type プロパティを設定します。
Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria の場合は、次の値を使用します。
"odata.type": "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria",
"allOf": [
{
"dimensions": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"metricName": "string",
"metricNamespace": "string",
"name": "string",
"skipMetricValidation": "bool",
"timeAggregation": "string",
"criterionType": "string"
// For remaining properties, see MultiMetricCriteria objects
}
]
Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria の場合は、次の値を使用します。
"odata.type": "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria",
"allOf": [
{
"criterionType": "string",
"dimensions": [
{
"name": "string",
"operator": "string",
"values": [ "string" ]
}
],
"metricName": "string",
"metricNamespace": "string",
"name": "string",
"operator": "string",
"skipMetricValidation": "bool",
"threshold": "int",
"timeAggregation": "string"
}
]
Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria の場合は、次の値を使用します。
"odata.type": "Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria",
"componentId": "string",
"failedLocationCount": "int",
"webTestId": "string"
MultiMetricCriteria オブジェクト
オブジェクトの種類を指定するには、 criterionType プロパティを設定します。
DynamicThresholdCriterion の場合は、次の値を使用します。
"criterionType": "DynamicThresholdCriterion",
"alertSensitivity": "string",
"failingPeriods": {
"minFailingPeriodsToAlert": "int",
"numberOfEvaluationPeriods": "int"
},
"ignoreDataBefore": "string",
"operator": "string"
StaticThresholdCriterion の場合は、次の値を使用します。
"criterionType": "StaticThresholdCriterion",
"operator": "string",
"threshold": "int"
プロパティ値
metricAlerts
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | 'Microsoft.Insights/metricAlerts' |
apiVersion | リソース API のバージョン | '2018-03-01' |
name | リソース名 | string (必須) 文字制限: 1 から 260 有効な文字: 次は使用できません: 末尾をスペースまたはピリオドにすることはできません。 |
location | リソースの場所 | string (必須) |
tags | リソース タグ | タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください |
properties | リソースのアラート ルールのプロパティ。 | MetricAlertProperties (必須) |
MetricAlertProperties
名前 | 説明 | 値 |
---|---|---|
actions | アラート ルールがアクティブになったとき、およびアラート条件が解決されたときに実行されるアクションの配列。 | MetricAlertAction[] |
autoMitigate | アラートを自動解決するかどうかを示すフラグ。 既定値は true です。 | [bool] |
条件 | は、特定のアラート条件情報を定義します。 | MetricAlertCriteria (必須) |
description | アラート メールに含まれるメトリック アラートの説明。 | string |
enabled | メトリック アラートが有効かどうかを示すフラグ。 | bool (必須) |
evaluationFrequency | メトリック アラートを評価する頻度を ISO 8601 期間形式で表します。 | string (必須) |
スコープ | このメトリック アラートのスコープが設定されているリソース ID の一覧。 | string[] (必須) |
severity | アラートの重大度 {0、1、2、3、4} | int (必須) |
targetResourceRegion | アラートが作成または更新されるターゲット リソースのリージョン。 スコープにサブスクリプション、リソース グループ、または複数のリソースが含まれている場合は必須です。 | string |
targetResourceType | アラートが作成または更新されるターゲット リソースのリソースの種類。 スコープにサブスクリプション、リソース グループ、または複数のリソースが含まれている場合は必須です。 | string |
windowSize | しきい値に基づいてアラート アクティビティを監視するために使用される期間 (ISO 8601 期間形式)。 | string (必須) |
MetricAlertAction
名前 | 説明 | 値 |
---|---|---|
actionGroupId | 使用するアクション グループの ID。 | string |
webHookProperties | このフィールドでは、Webhook への入力として送信されるアラート ペイロードに追加されるカスタム プロパティを指定できます。 | object |
MetricAlertCriteria
MetricAlertMultipleResourceMultipleMetricCriteria
名前 | 説明 | 値 |
---|---|---|
odata.type | は、アラート条件の種類を指定します。 | 'Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria' (必須) |
allOf | この 'all of' 操作の複数のメトリック条件の一覧。 | MultiMetricCriteria[] |
MultiMetricCriteria
名前 | 説明 | 値 |
---|---|---|
dimensions | ディメンション条件の一覧。 | MetricDimension[] |
metricName | メトリックの名前。 | string (必須) |
metricNamespace | メトリックの名前空間。 | string |
name | 条件の名前。 | string (必須) |
skipMetricValidation | メトリック検証をスキップすることによって、まだ出力されていないカスタム メトリックに対するアラート ルールの作成を許可します。 | [bool] |
timeAggregation | 条件の時間集計の種類。 | 'Average' 'Count' 'Maximum' 'Minimum' 'Total' (必須) |
criterionType | オブジェクトの種類を設定する | DynamicThresholdCriterion StaticThresholdCriterion (必須) |
MetricDimension
名前 | 説明 | 値 |
---|---|---|
name | ディメンションの名前。 | string (必須) |
operator | ディメンション演算子。 'Include' と 'Exclude' のみがサポートされています | string (必須) |
値 | ディメンション値の一覧。 | string[] (必須) |
DynamicMetricCriteria
名前 | 説明 | 値 |
---|---|---|
criterionType | しきい値の条件の種類を指定します | 'DynamicThresholdCriterion' (必須) |
alertSensitivity | アラートをトリガーするために必要な偏差の範囲。 これは、メトリック系列パターンに対するしきい値の厳しい程度に影響します。 | 'High' 'Low' 'Medium' (必須) |
failingPeriods | アラートの発生に必要な、選択したルックバック時間枠内で必要な違反の最小数。 | DynamicThresholdFailingPeriods (必須) |
ignoreDataBefore | このオプションを使用して、メトリック履歴データの学習を開始する日付を設定し、動的しきい値を計算する (ISO8601形式) | string |
operator | メトリック値としきい値の比較に使用される演算子。 | 'GreaterOrLessThan' 'GreaterThan' 'LessThan' (必須) |
DynamicThresholdFailingPeriods
名前 | 説明 | 値 |
---|---|---|
minFailingPeriodsToAlert | アラートをトリガーする違反の数。 numberOfEvaluationPeriods 以下にする必要があります。 | int (必須) |
numberOfEvaluationPeriods | 集計されたルックバック ポイントの数。 ルックバック タイム ウィンドウは、集計粒度 (windowSize) と、選択した集計ポイント数に基づいて計算されます。 | int (必須) |
MetricCriteria
名前 | 説明 | 値 |
---|---|---|
criterionType | しきい値条件の種類を指定します | 'DynamicThresholdCriterion' 'StaticThresholdCriterion' (必須) |
dimensions | ディメンション条件の一覧。 | MetricDimension[] |
metricName | メトリックの名前。 | string (必須) |
metricNamespace | メトリックの名前空間。 | string |
name | 条件の名前。 | string (必須) |
operator | criteria 演算子。 | 'Equals' 'GreaterThan' 'GreaterThanOrEqual' 'LessThan' 'LessThanOrEqual' (必須) |
skipMetricValidation | メトリック検証をスキップすることによって、まだ出力されていないカスタム メトリックに対するアラート ルールの作成を許可します。 | [bool] |
threshold | アラートをアクティブにする条件しきい値。 | int (必須) |
timeAggregation | 条件の時間集計の種類。 | 'Average' 'Count' 'Maximum' 'Minimum' 'Total' (必須) |
MetricAlertSingleResourceMultipleMetricCriteria
名前 | 説明 | 値 |
---|---|---|
odata.type | は、アラート条件の種類を指定します。 | 'Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria' (必須) |
allOf | この "all of" 操作のメトリック条件の一覧。 | MetricCriteria[] |
WebtestLocationAvailabilityCriteria
名前 | 説明 | 値 |
---|---|---|
odata.type | は、アラート条件の種類を指定します。 | 'Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria' (必須) |
componentId | Application Insights リソース ID。 | string (必須) |
failedLocationCount | 失敗した場所の数。 | int (必須) |
webTestId | Application Insights Web テスト ID。 | string (必須) |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
Template | 説明 |
---|---|
BrowserBox Azure Edition |
このテンプレートは、Azure Ubuntu Server 22.04 LTS、Debian 11、または RHEL 8.7 LVM VM に BrowserBox をデプロイします。 |
スケーラブルな Umbraco CMS Web アプリ |
このテンプレートは、umbraco CMS Web アプリをAzure App Service Web Appsに簡単にデプロイする方法を提供します。 |
Application Gatewayのアラートを作成する |
これらのテンプレートを使用して、Azure Application Gatewayの重要なイベント アラートを簡単に作成できます。 |
バックエンドの最後のバイト応答メトリックのアラート |
このようなテンプレートを使用して、Azure Application Gatewayの重要なイベント アラートを簡単に作成できます。 |
異常なホスト数メトリックのアラート |
このようなテンプレートを使用して、Azure Application Gatewayの重要なイベント アラートを簡単に作成できます。 |
Enterprise Governance-AppService、SQL DB、AD、OMS、Runbook |
小規模または大規模なエンタープライズ向けのクラウド導入では、クラウド デプロイから価値を引き出すために、責任ある効率的なガバナンス モデルが必要です。 CloudWise (ソリューションのコード名) は、Azure Partner QuickStarts から入手できる複合ソリューションであり、顧客、システム インテグレーター、パートナーの導入を可能にする企業であり、コストの最適化、アプリケーションの信頼性の向上、ビジネス リスクの削減に重点を置いた、セルフサービスで自動化されたガバナンスと運用ソリューションを提供します。 このソリューションでは、可視性と制御の主要なガバナンスの柱が強調されています。 |
動的 Web テストの作成 |
任意の数の App Insights Web (ping) テストを作成します。 |
Application Insight をデプロイし、アラートを作成する |
このテンプレートを使用すると、Application Insight をデプロイし、その中にアラートを作成できます |
動的しきい値を持つメトリック アラート ルール |
このテンプレートでは、動的しきい値条件の種類を使用して仮想マシンの CPU 使用率メトリックを監視するメトリック アラート ルールを作成します。 |
静的しきい値を持つメトリック アラート ルール |
このテンプレートでは、静的しきい値条件の種類を使用して仮想マシンの CPU 使用率メトリックを監視するメトリック アラート ルールを作成します。 |
可用性テストのメトリック アラート ルール |
このテンプレートは、Application Insights 可用性テストと、それを監視するメトリック アラート ルールを作成します。 |
Terraform (AzAPI プロバイダー) リソース定義
metricAlerts リソースの種類は、次をターゲットとする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.Insights/metricAlerts リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Insights/metricAlerts@2018-03-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
actions = [
{
actionGroupId = "string"
webHookProperties = {}
}
]
autoMitigate = bool
criteria = {
odata.type = "string"
// For remaining properties, see MetricAlertCriteria objects
}
description = "string"
enabled = bool
evaluationFrequency = "string"
scopes = [
"string"
]
severity = int
targetResourceRegion = "string"
targetResourceType = "string"
windowSize = "string"
}
})
}
MetricAlertCriteria オブジェクト
オブジェクトの種類を指定するには、 odata.type プロパティを設定します。
Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria の場合は、次の値を使用します。
odata.type = "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria"
allOf = [
{
dimensions = [
{
name = "string"
operator = "string"
values = [
"string"
]
}
]
metricName = "string"
metricNamespace = "string"
name = "string"
skipMetricValidation = bool
timeAggregation = "string"
criterionType = "string"
// For remaining properties, see MultiMetricCriteria objects
}
]
Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria の場合は、次の値を使用します。
odata.type = "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria"
allOf = [
{
criterionType = "string"
dimensions = [
{
name = "string"
operator = "string"
values = [
"string"
]
}
]
metricName = "string"
metricNamespace = "string"
name = "string"
operator = "string"
skipMetricValidation = bool
threshold = int
timeAggregation = "string"
}
]
Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria の場合は、次の値を使用します。
odata.type = "Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria"
componentId = "string"
failedLocationCount = int
webTestId = "string"
MultiMetricCriteria オブジェクト
オブジェクトの種類を指定するには、 criterionType プロパティを設定します。
DynamicThresholdCriterion の場合は、次の値を使用します。
criterionType = "DynamicThresholdCriterion"
alertSensitivity = "string"
failingPeriods = {
minFailingPeriodsToAlert = int
numberOfEvaluationPeriods = int
}
ignoreDataBefore = "string"
operator = "string"
StaticThresholdCriterion の場合は、次の値を使用します。
criterionType = "StaticThresholdCriterion"
operator = "string"
threshold = int
プロパティ値
metricAlerts
名前 | 説明 | 値 |
---|---|---|
type | リソースの種類 | "Microsoft.Insights/metricAlerts@2018-03-01" |
name | リソース名 | string (必須) 文字制限: 1 から 260 有効な文字: 次は使用できません: 末尾をスペースまたはピリオドにすることはできません。 |
location | リソースの場所 | string (必須) |
parent_id | リソース グループにデプロイするには、そのリソース グループの ID を使用します。 | string (必須) |
tags | リソース タグ | タグの名前と値のディクショナリ。 |
properties | リソースのアラート ルールのプロパティ。 | MetricAlertProperties (必須) |
MetricAlertProperties
名前 | 説明 | 値 |
---|---|---|
actions | アラート ルールがアクティブになったとき、およびアラート条件が解決されたときに実行されるアクションの配列。 | MetricAlertAction[] |
autoMitigate | アラートを自動解決するかどうかを示すフラグ。 既定値は true です。 | [bool] |
条件 | は、特定のアラート条件情報を定義します。 | MetricAlertCriteria (必須) |
description | アラート メールに含まれるメトリック アラートの説明。 | string |
enabled | メトリック アラートが有効かどうかを示すフラグ。 | bool (必須) |
evaluationFrequency | メトリック アラートを評価する頻度を ISO 8601 期間形式で表します。 | string (必須) |
スコープ | このメトリック アラートのスコープが設定されているリソース ID の一覧。 | string[] (必須) |
severity | アラートの重大度 {0、1、2、3、4} | int (必須) |
targetResourceRegion | アラートが作成または更新されるターゲット リソースのリージョン。 スコープにサブスクリプション、リソース グループ、または複数のリソースが含まれている場合は必須です。 | string |
targetResourceType | アラートが作成または更新されるターゲット リソースのリソースの種類。 スコープにサブスクリプション、リソース グループ、または複数のリソースが含まれている場合は必須です。 | string |
windowSize | しきい値に基づいてアラート アクティビティを監視するために使用される期間 (ISO 8601 期間形式)。 | string (必須) |
MetricAlertAction
名前 | 説明 | 値 |
---|---|---|
actionGroupId | 使用するアクション グループの ID。 | string |
webHookProperties | このフィールドでは、Webhook への入力として送信されるアラート ペイロードに追加されるカスタム プロパティを指定できます。 | object |
MetricAlertCriteria
MetricAlertMultipleResourceMultipleMetricCriteria
名前 | 説明 | 値 |
---|---|---|
odata.type | は、アラート条件の種類を指定します。 | "Microsoft.Azure.Monitor.MultipleResourceMultipleMetricCriteria" (必須) |
allOf | この 'all of' 操作の複数のメトリック条件の一覧。 | MultiMetricCriteria[] |
MultiMetricCriteria
名前 | 説明 | 値 |
---|---|---|
dimensions | ディメンション条件の一覧。 | MetricDimension[] |
metricName | メトリックの名前。 | string (必須) |
metricNamespace | メトリックの名前空間。 | string |
name | 条件の名前。 | string (必須) |
skipMetricValidation | メトリック検証をスキップすることによって、まだ出力されていないカスタム メトリックに対するアラート ルールの作成を許可します。 | [bool] |
timeAggregation | 条件の時間集計の種類。 | "Average" "Count" "Maximum" "最小" "Total" (必須) |
criterionType | オブジェクトの種類を設定する | DynamicThresholdCriterion StaticThresholdCriterion (必須) |
MetricDimension
名前 | 説明 | 値 |
---|---|---|
name | ディメンションの名前。 | string (必須) |
operator | ディメンション演算子。 'Include' と 'Exclude' のみがサポートされています | string (必須) |
値 | ディメンション値の一覧。 | string[] (必須) |
DynamicMetricCriteria
名前 | 説明 | 値 |
---|---|---|
criterionType | しきい値条件の種類を指定します | "DynamicThresholdCriterion" (必須) |
alertSensitivity | アラートをトリガーするために必要な偏差の範囲。 これは、メトリック系列パターンに対するしきい値の厳しい程度に影響します。 | "High" "Low" "Medium" (必須) |
failingPeriods | アラートを発生させるために必要な、選択したルックバック時間枠内に必要な違反の最小数。 | DynamicThresholdFailingPeriods (必須) |
ignoreDataBefore | このオプションを使用して、メトリック履歴データの学習を開始する日付を設定し、動的しきい値を計算する (ISO8601形式) | string |
operator | メトリック値をしきい値と比較するために使用される演算子。 | "GreaterOrLessThan" "GreaterThan" "LessThan" (必須) |
DynamicThresholdFailingPeriods
名前 | 説明 | 値 |
---|---|---|
minFailingPeriodsToAlert | アラートをトリガーする違反の数。 numberOfEvaluationPeriods 以下にする必要があります。 | int (必須) |
numberOfEvaluationPeriods | 集計されたルックバック ポイントの数。 ルックバック 時間枠は、集計粒度 (windowSize) と、選択した集計ポイント数に基づいて計算されます。 | int (必須) |
MetricCriteria
名前 | 説明 | 値 |
---|---|---|
criterionType | しきい値条件の種類を指定します | "DynamicThresholdCriterion" "StaticThresholdCriterion" (必須) |
dimensions | ディメンション条件の一覧。 | MetricDimension[] |
metricName | メトリックの名前。 | string (必須) |
metricNamespace | メトリックの名前空間。 | string |
name | 条件の名前。 | string (必須) |
operator | criteria 演算子。 | "Equals" "GreaterThan" "GreaterThanOrEqual" "LessThan" "LessThanOrEqual" (必須) |
skipMetricValidation | メトリック検証をスキップすることによって、まだ出力されていないカスタム メトリックに対するアラート ルールの作成を許可します。 | [bool] |
threshold | アラートをアクティブにする条件しきい値。 | int (必須) |
timeAggregation | 条件の時間集計の種類。 | "Average" "Count" "Maximum" "最小" "Total" (必須) |
MetricAlertSingleResourceMultipleMetricCriteria
名前 | 説明 | 値 |
---|---|---|
odata.type | は、アラート条件の種類を指定します。 | "Microsoft.Azure.Monitor.SingleResourceMultipleMetricCriteria" (必須) |
allOf | この "all of" 操作のメトリック条件の一覧。 | MetricCriteria[] |
WebtestLocationAvailabilityCriteria
名前 | 説明 | 値 |
---|---|---|
odata.type | は、アラート条件の種類を指定します。 | "Microsoft.Azure.Monitor.WebtestLocationAvailabilityCriteria" (必須) |
componentId | Application Insights リソース ID。 | string (必須) |
failedLocationCount | 失敗した場所の数。 | int (必須) |
webTestId | Application Insights Web テスト ID。 | string (必須) |
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示