New-AzScheduledQueryRule
Crie uma regra de consulta agendada.
Sintaxe
CreateExpanded (Predefinição)
New-AzScheduledQueryRule
-Name <String>
-ResourceGroupName <String>
-Location <String>
[-SubscriptionId <String>]
[-ActionCustomProperty <Hashtable>]
[-ActionGroupResourceId <String[]>]
[-AutoMitigate]
[-CheckWorkspaceAlertsStorageConfigured]
[-CriterionAllOf <ICondition[]>]
[-Description <String>]
[-DisplayName <String>]
[-Enabled]
[-EvaluationFrequency <TimeSpan>]
[-Kind <String>]
[-MuteActionsDuration <TimeSpan>]
[-OverrideQueryTimeRange <TimeSpan>]
[-Scope <String[]>]
[-Severity <Int64>]
[-SkipQueryValidation]
[-Tag <Hashtable>]
[-TargetResourceType <String[]>]
[-WindowSize <TimeSpan>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaJsonFilePath
New-AzScheduledQueryRule
-Name <String>
-ResourceGroupName <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
CreateViaJsonString
New-AzScheduledQueryRule
-Name <String>
-ResourceGroupName <String>
-JsonString <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Crie uma regra de consulta agendada.
Exemplos
Exemplo 1: Criar regra de consulta agendada
$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
Criar regra de consulta agendada
Parâmetros
-ActionCustomProperty
As propriedades de uma carga útil de alerta.
Propriedades dos parâmetros
Tipo: Hashtable
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
CreateExpanded
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-ActionGroupResourceId
Ids de recurso do Grupo de Ações para invocar quando o alerta for acionado.
Propriedades dos parâmetros
Tipo: String [ ]
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
CreateExpanded
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-AutoMitigate
O sinalizador que indica se o alerta deve ser resolvido automaticamente ou não.
O padrão é verdadeiro.
Relevante apenas para regras do tipo LogAlert.
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
CreateExpanded
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
O sinalizador que indica se essa regra de consulta agendada deve ser armazenada no armazenamento do cliente.
O padrão é "false".
Relevante apenas para regras do tipo LogAlert.
Tipo: SwitchParameter
Default value: None
Suporta carateres universais: False
NãoMostrar: False
CreateExpanded
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-Confirm
Solicita confirmação antes de executar o cmdlet.
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Aliases: Cf.
Conjuntos de parâmetros
(All)
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-CriterionAllOf
Uma lista de condições a serem avaliadas em relação aos escopos especificados
Propriedades dos parâmetros
Tipo: ICondition [ ]
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
CreateExpanded
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-DefaultProfile
O parâmetro DefaultProfile não é funcional.
Use o parâmetro SubscriptionId quando disponível se estiver executando o cmdlet em uma assinatura diferente.
Propriedades dos parâmetros
Tipo: PSObject
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Aliases: AzureRMContext, AzureCredential
Conjuntos de parâmetros
(All)
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-Description
A descrição da regra de consulta agendada.
Propriedades dos parâmetros
Tipo: String
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
CreateExpanded
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-DisplayName
O nome para exibição da regra de alerta
Propriedades dos parâmetros
Tipo: String
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
CreateExpanded
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-Enabled
O sinalizador que indica se essa regra de consulta agendada está habilitada.
O valor deve ser verdadeiro ou falso
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
CreateExpanded
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-EvaluationFrequency
A frequência com que a regra de consulta agendada é avaliada representada no formato de duração ISO 8601.
Relevante e necessário apenas para regras do tipo LogAlert.
Propriedades dos parâmetros
Tipo: TimeSpan
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
CreateExpanded
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-JsonFilePath
Caminho do arquivo Json fornecido para a operação Create
Propriedades dos parâmetros
Tipo: String
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
CreateViaJsonFilePath
Position: Named
Obrigatório: True
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-JsonString
Cadeia de caracteres Json fornecida para a operação Create
Propriedades dos parâmetros
Tipo: String
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
CreateViaJsonString
Position: Named
Obrigatório: True
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-Kind
Indica o tipo de regra de consulta agendada.
O padrão é LogAlert.
Propriedades dos parâmetros
Tipo: String
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
CreateExpanded
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-Location
A geolocalização onde o recurso vive
Propriedades dos parâmetros
Tipo: String
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
CreateExpanded
Position: Named
Obrigatório: True
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-MuteActionsDuration
Silencie ações pelo período de tempo escolhido (no formato de duração ISO 8601) depois que o alerta for acionado.
Relevante apenas para regras do tipo LogAlert.
Propriedades dos parâmetros
Tipo: TimeSpan
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
CreateExpanded
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-Name
O nome da regra.
Propriedades dos parâmetros
Tipo: String
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
(All)
Position: Named
Obrigatório: True
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-OverrideQueryTimeRange
Se especificado, substitui o intervalo de tempo de consulta (o padrão é WindowSize*NumberOfEvaluationPeriods).
Relevante apenas para regras do tipo LogAlert.
Propriedades dos parâmetros
Tipo: TimeSpan
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
CreateExpanded
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-ResourceGroupName
O nome do grupo de recursos.
O nome não diferencia maiúsculas de minúsculas.
Propriedades dos parâmetros
Tipo: String
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
(All)
Position: Named
Obrigatório: True
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-Scope
A lista de ids de recurso para as quais esta regra de consulta agendada tem escopo.
Propriedades dos parâmetros
Tipo: String [ ]
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
CreateExpanded
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-Severity
Severidade do alerta.
Deve ser um número inteiro entre [0-4].
O valor de 0 é mais severo.
Relevante e necessário apenas para regras do tipo LogAlert.
Propriedades dos parâmetros
Tipo: Int64
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
CreateExpanded
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-SkipQueryValidation
O sinalizador que indica se a consulta fornecida deve ser validada ou não.
O padrão é "false".
Relevante apenas para regras do tipo LogAlert.
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
CreateExpanded
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-SubscriptionId
A ID da assinatura de destino.
Propriedades dos parâmetros
Tipo: String
Default value: (Get-AzContext).Subscription.Id
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
(All)
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-Tag
Tags de recursos.
Propriedades dos parâmetros
Tipo: Hashtable
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
CreateExpanded
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-TargetResourceType
Lista do tipo de recurso do(s) recurso(s) de destino no qual o alerta é criado/atualizado.
Por exemplo, se o âmbito for um grupo de recursos e os Tipos-RecursoDestino forem Microsoft. Compute/virtualMachines, depois será lançado um alerta diferente para cada máquina virtual do grupo de recursos que cumpra os critérios de alerta.
Relevante apenas para regras do tipo LogAlert
Propriedades dos parâmetros
Tipo: String [ ]
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
CreateExpanded
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado.
O cmdlet não é executado.
Propriedades dos parâmetros
Tipo: SwitchParameter
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Aliases: Wi
Conjuntos de parâmetros
(All)
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
-WindowSize
O período de tempo (no formato de duração ISO 8601) no qual a consulta Alerta será executada (tamanho do compartimento).
Relevante e necessário apenas para regras do tipo LogAlert.
Propriedades dos parâmetros
Tipo: TimeSpan
Default value: None
Suporta carateres universais: False
NãoMostrar: False
Conjuntos de parâmetros
CreateExpanded
Position: Named
Obrigatório: False
Valor do pipeline: False
Valor do pipeline por nome de propriedade: False
Valor dos restantes argumentos: False
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters .
Saídas