Add-AzMetricAlertRule

モジュール:: Az.Monitor Module

クラシックメトリックベースのアラートルールを追加または更新します (パブリッククラウドでは既に廃止されています)。新しいメトリックアラートルールを作成するには、 Add-AzMetricAlertRuleV2 コマンドレットを使用します。

構文

Default (既定)

Add-AzMetricAlertRule
    -WindowSize <TimeSpan>
    -Operator <ConditionOperator>
    -Threshold <Double>
    -TargetResourceId <String>
    -MetricName <String>
    -TimeAggregationOperator <TimeAggregationOperator>
    -Location <String>
    [-Description <String>]
    [-DisableRule]
    -ResourceGroupName <String>
    -Name <String>
    [-Action <System.Collections.Generic.List`1[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction]>]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

説明

Add-AzMetricAlertRule コマンドレットは、メトリックベースのアラートルールを追加または更新します。追加されたルールはリソースグループに関連付けられ、名前が付けられます。このコマンドレットは ShouldProcess パターンを実装します。つまり、リソースを実際に作成、変更、または削除する前に、ユーザーに確認を要求する場合があります。

例

例 1: Web サイトにメトリックアラートルールを追加する

Add-AzMetricAlertRule -Name "metricRule5" -Location "East US" -ResourceGroup "Default-Web-EastUS" -Operator GreaterThan -Threshold 2 -WindowSize 00:05:00 -MetricName "Requests" -Description "Pura Vida" -TimeAggregationOperator Total

RequestId                                                                                                    StatusCode
---------                                                                                                    ----------
33574ccf-0b01-43b4-aa97-87e6bbcf1c11                                                                         Created

このコマンドは、Web サイトのメトリックアラートルールを作成します。

例 2: ルールを無効にする

Add-AzMetricAlertRule -Name "metricRule5" -Location "East US" -ResourceGroup Default-Web-EastUS -Operator GreaterThan -Threshold 2 -WindowSize 00:05:00 -MetricName "Requests" -TimeAggregationOperator Total

RequestId                                                                                                    StatusCode
---------                                                                                                    ----------
96c489f1-8529-46e1-a76d-2c1463ca3116                                                                                 OK

このコマンドはルールを無効にします。ルールが存在しない場合は、無効に作成されます。ルールが存在する場合は、単にそれを無効にします。

例 3: アクションを含むルールを追加する

Add-AzMetricAlertRule -Name "metricRule5" -Location "East US" -ResourceGroup "Default-Web-EastUS" -Operator GreaterThan -Threshold 1 -TargetResourceId "/subscriptions/b93fb07a-6f93-30be-bf3e-4f0deca15f4f/resourceGroups/Default-Web-EastUS/providers/microsoft.web/sites/mywebsite" -MetricName "Requests" -TimeAggregationOperator Total

RequestId                                                                                                    StatusCode
---------                                                                                                    ----------
9a5bc388-c7ac-4dc6-aa70-f4bc29c2c712                                                                                 OK

このコマンドは、Web サイトのメトリックアラートルールを作成します。

パラメーター

-Action

アクションのコンマ区切りのリストを指定します。

パラメーターのプロパティ

型:	List<T>[RuleAction]
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-Confirm

コマンドレットを実行する前に確認を求めるメッセージが表示されます。

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
Aliases:	cf

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-DefaultProfile

Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション

パラメーターのプロパティ

型:	IAzureContextContainer
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-Description

ルールの説明を指定します。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-DisableRule

ルールを無効にします。このパラメーターを指定しない場合、ルールは有効になります。

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-Location

ルールが定義されている場所を指定します。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	True
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-MetricName

ルールが監視しているメトリックの名前を指定します。このパラメーターは、メトリックベースのルールに対してのみ指定します。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	True
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-Name

ルールの名前を指定します。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	True
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-Operator

ルールの条件の関係演算子を指定します。このパラメーターに使用できる値は次のとおりです。

GreaterThan
より大きいまたは等しい
LessThan
LessThanOrEqual

パラメーターのプロパティ

型:	ConditionOperator
規定値:	None
指定可能な値:	GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	True
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-ResourceGroupName

ルールのリソースグループの名前を指定します。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
Aliases:	リソースグループ（ResourceGroup）

パラメーターセット

(All)

配置:	Named
必須:	True
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-TargetResourceId

ルールが監視しているリソースの ID を指定します。注: このプロパティは、既存のアラートルールでは更新できません。

パラメーターのプロパティ

型:	String
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	True
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-Threshold

ルールのしきい値を指定します。

パラメーターのプロパティ

型:	Double
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	True
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-TimeAggregationOperator

ルールの評価時に時間枠に適用する集計演算子を指定します。

パラメーターのプロパティ

型:	Nullable<T>[TimeAggregationOperator]
規定値:	None
指定可能な値:	Average, Minimum, Maximum, Total, Last
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	True
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

-WhatIf

コマンドレットを実行した場合の動作を示します。コマンドレットは実行されません。

パラメーターのプロパティ

型:	SwitchParameter
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False
Aliases:	ウィスコンシン

パラメーターセット

(All)

配置:	Named
必須:	False
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	False
残りの引数からの値:	False

-WindowSize

データを計算するルールの時間枠のサイズを指定します。

パラメーターのプロパティ

型:	TimeSpan
規定値:	None
ワイルドカードのサポート:	False
DontShow:	False

パラメーターセット

(All)

配置:	Named
必須:	True
パイプラインからの値:	False
プロパティ名別のパイプラインからの値:	True
残りの引数からの値:	False

CommonParameters

このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。詳細については、about_CommonParametersを参照してください。

次の方法で共有

Add-AzMetricAlertRule

構文

Default (既定)

説明

例

例 1: Web サイトにメトリック アラート ルールを追加する

例 2: ルールを無効にする

例 3: アクションを含むルールを追加する

パラメーター

-Action

パラメーターのプロパティ

パラメーター セット

-Confirm

パラメーターのプロパティ

パラメーター セット

-DefaultProfile

パラメーターのプロパティ

パラメーター セット

-Description

パラメーターのプロパティ

パラメーター セット

-DisableRule

パラメーターのプロパティ

パラメーター セット

-Location

パラメーターのプロパティ

パラメーター セット

-MetricName

パラメーターのプロパティ

パラメーター セット

-Name

パラメーターのプロパティ

パラメーター セット

-Operator

パラメーターのプロパティ

パラメーター セット

-ResourceGroupName

パラメーターのプロパティ

パラメーター セット

-TargetResourceId

パラメーターのプロパティ

パラメーター セット

-Threshold

パラメーターのプロパティ

パラメーター セット

-TimeAggregationOperator

パラメーターのプロパティ

パラメーター セット

-WhatIf

パラメーターのプロパティ

パラメーター セット

-WindowSize

パラメーターのプロパティ

パラメーター セット

CommonParameters

入力

出力

関連リンク

フィードバック

例 1: Web サイトにメトリックアラートルールを追加する

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット

パラメーターセット