New-AzScheduledQueryRule

建立或更新排程的查詢規則。

Syntax

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>]

Description

建立或更新排程的查詢規則。

範例

範例 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

動作群組資源標識碼,以在警示引發時叫用。

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

執行 Cmdlet 之前先提示您確認。

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

-CriterionAllOf

針對要建構之指定範圍評估的條件清單,請參閱 CRITERIONALLOF 屬性的 NOTES 區段並建立哈希表。

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

-DefaultProfile

DefaultProfile 參數無法運作。 如果針對不同的訂用帳戶執行 Cmdlet,請使用 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

此排程查詢規則的範圍是資源標識碼的清單。

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

目標訂用帳戶的標識碼。

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

顯示執行 Cmdlet 後會發生的情況。 未執行 Cmdlet。

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