New-AzScheduledQueryRule

スケジュールされたクエリ ルールを作成または更新します。

構文

New-AzScheduledQueryRule
   -Name <String>
   -ResourceGroupName <String>
   [-SubscriptionId <String>]
   -Location <String>
   [-ActionCustomProperty <Hashtable>]
   [-ActionGroupResourceId <String[]>]
   [-AutoMitigate]
   [-CheckWorkspaceAlertsStorageConfigured]
   [-CriterionAllOf <ICondition[]>]
   [-Description <String>]
   [-DisplayName <String>]
   [-Enabled]
   [-EvaluationFrequency <TimeSpan>]
   [-Kind <Kind>]
   [-MuteActionsDuration <TimeSpan>]
   [-OverrideQueryTimeRange <TimeSpan>]
   [-Scope <String[]>]
   [-Severity <Int64>]
   [-SkipQueryValidation]
   [-Tag <Hashtable>]
   [-TargetResourceType <String[]>]
   [-WindowSize <TimeSpan>]
   [-DefaultProfile <PSObject>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

説明

スケジュールされたクエリ ルールを作成または更新します。

例 1: スケジュールされたクエリ ルールを作成する

$subscriptionId=(Get-AzContext).Subscription.Id
$dimension = New-AzScheduledQueryRuleDimensionObject -Name Computer -Operator Include -Value *
$condition=New-AzScheduledQueryRuleConditionObject -Dimension $dimension -Query "Perf | where ObjectName == `"Processor`" and CounterName == `"% Processor Time`" | summarize AggregatedValue = avg(CounterValue) by bin(TimeGenerated, 5m), Computer" -TimeAggregation "Average" -MetricMeasureColumn "AggregatedValue" -Operator "GreaterThan" -Threshold "70" -FailingPeriodNumberOfEvaluationPeriod 1 -FailingPeriodMinFailingPeriodsToAlert 1
New-AzScheduledQueryRule -Name test-rule -ResourceGroupName test-group -Location eastus -DisplayName test-rule -Scope "/subscriptions/$subscriptionId/resourceGroups/test-group/providers/Microsoft.Compute/virtualMachines/test-vm" -Severity 4 -WindowSize ([System.TimeSpan]::New(0,10,0)) -EvaluationFrequency ([System.TimeSpan]::New(0,5,0)) -CriterionAllOf $condition

スケジュールされたクエリ ルールを作成する

パラメーター

-ActionCustomProperty

アラート ペイロードのプロパティ。

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ActionGroupResourceId

アラートが発生したときに呼び出すアクション グループ リソース ID。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AutoMitigate

アラートを自動的に解決するかどうかを示すフラグ。 既定値は true です。 LogAlert の種類のルールにのみ関連します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CheckWorkspaceAlertsStorageConfigured

このスケジュールされたクエリ ルールを顧客のストレージに格納するかどうかを示すフラグ。 既定値は false です。 LogAlert の種類のルールにのみ関連します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CriterionAllOf

指定したスコープに対して評価する条件の一覧を構築するには、CRITERIONAL時プロパティの NOTES セクションを参照し、ハッシュ テーブルを作成します。

Type:ICondition[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

DefaultProfile パラメーターは機能しません。 別のサブスクリプションに対してコマンドレットを実行する場合は、使用可能な場合は SubscriptionId パラメーターを使用します。

Type:PSObject
Aliases:AzureRMContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

スケジュールされたクエリ ルールの説明。

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisplayName

アラート ルールの表示名

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Enabled

このスケジュールされたクエリ ルールが有効かどうかを示すフラグ。 値は true または false にする必要があります

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EvaluationFrequency

スケジュールされたクエリ ルールが評価される頻度は、ISO 8601 期間形式で表されます。 LogAlert の種類のルールにのみ関連し、必須です。

Type:TimeSpan
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Kind

スケジュールされたクエリ ルールの種類を示します。 既定値は LogAlert です。

Type:Kind
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Location

リソースが存在する地理的な場所

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-MuteActionsDuration

アラートが発生した後、選択した期間 (ISO 8601 期間形式) のアクションをミュートします。 LogAlert の種類のルールにのみ関連します。

Type:TimeSpan
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

ルールの名前です。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-OverrideQueryTimeRange

指定した場合は、クエリの時間範囲をオーバーライドします (既定値は WindowSize*NumberOfEvaluationPeriods)。 LogAlert の種類のルールにのみ関連します。

Type:TimeSpan
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ResourceGroupName

リソース グループの名前。 名前の大文字と小文字は区別されます。

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Scope

このスケジュールされたクエリ ルールのスコープが設定されているリソース ID の一覧。

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Severity

アラートの重大度。 [0- 4] の整数にする必要があります。 値 0 が最も厳しい。 LogAlert の種類のルールにのみ関連し、必須です。

Type:Int64
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SkipQueryValidation

指定されたクエリを検証するかどうかを示すフラグ。 既定値は false です。 LogAlert の種類のルールにのみ関連します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SubscriptionId

ターゲット サブスクリプションの ID。

Type:String
Position:Named
Default value:(Get-AzContext).Subscription.Id
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tag

リソース タグ。

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-TargetResourceType

アラートが作成または更新されるターゲット リソースのリソースの種類の一覧。 たとえば、スコープがリソース グループであり、targetResourceTypes が Microsoft.Compute/virtualMachines の場合、アラート条件を満たすリソース グループ内の仮想マシンごとに異なるアラートが発生します。 LogAlert の種類のルールにのみ関連します

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

コマンドレットの実行時に発生する内容を示します。 このコマンドレットは実行されません。

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WindowSize

アラート クエリが実行される期間 (ISO 8601 期間形式) (ビン サイズ)。 LogAlert の種類のルールにのみ関連し、必須です。

Type:TimeSpan
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

出力

IScheduledQueryRuleResource