Add-AzMetricAlertRule
claasic メトリックベースのアラート ルールを追加または更新します (パブリック クラウドでは既に廃止されています)。 新しいメトリック アラート ルールを作成するには、 Add-AzMetricAlertRuleV2 コマンドレットを使用します。
構文
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] |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Confirm
コマンドレットの実行前に確認を求めるメッセージが表示されます。
型: | SwitchParameter |
Aliases: | cf |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-DefaultProfile
Azure との通信に使用される資格情報、アカウント、テナント、サブスクリプション
型: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-Description
ルールの説明を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-DisableRule
ルールを無効にします。 このパラメーターを指定しない場合、ルールは有効になります。
型: | SwitchParameter |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Location
ルールが定義されている場所を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-MetricName
ルールが監視しているメトリックの名前を指定します。 このパラメーターは、メトリックベースのルールに対してのみ指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Name
ルールの名前を指定します。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Operator
ルールの条件の関係演算子を指定します。 このパラメーターの有効値は、次のとおりです。
- GreaterThan
- GreaterThanOrEqual
- LessThan
- LessThanOrEqual
型: | ConditionOperator |
指定可能な値: | GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-ResourceGroupName
ルールのリソース グループの名前を指定します。
型: | String |
Aliases: | ResourceGroup |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-TargetResourceId
ルールが監視しているリソースの ID を指定します。 注: このプロパティは、既存のアラート ルールでは更新できません。
型: | String |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-Threshold
ルールのしきい値を指定します。
型: | Double |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-TimeAggregationOperator
ルールの評価時に時間枠に適用する集計演算子を指定します。
型: | Nullable<T>[TimeAggregationOperator] |
指定可能な値: | Average, Minimum, Maximum, Total, Last |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
-WhatIf
コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。
型: | SwitchParameter |
Aliases: | wi |
配置: | Named |
規定値: | None |
必須: | False |
パイプライン入力を受け取る: | False |
ワイルドカード文字を受け取る: | False |
-WindowSize
データを計算するルールの時間枠のサイズを指定します。
型: | TimeSpan |
配置: | Named |
規定値: | None |
必須: | True |
パイプライン入力を受け取る: | True |
ワイルドカード文字を受け取る: | False |
入力
Nullable<T>[[Microsoft.Azure.Management.Monitor.Management.Models.TimeAggregationOperator, Microsoft.Azure.PowerShell.Cmdlets.Monitor, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
List<T>[[Microsoft.Azure.Management.Monitor.Management.Models.RuleAction, Microsoft.Azure.PowerShell.Cmdlets.Monitor, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]]
出力
PSAddAlertRuleOperationResponse
関連リンク
Azure PowerShell