Compartilhar via

New-AzScheduledQueryRule

Módulo:
Az.Monitor Module

Crie uma regra de consulta agendada.

Sintaxe

CreateExpanded (Default) 

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 um conteúdo de alerta.

Propriedades do parâmetro

Tipo:Hashtable
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

CreateExpanded
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ActionGroupResourceId

IDs de recurso do Grupo de Ações a serem invocadas quando o alerta é acionado.

Propriedades do parâmetro

Tipo:

String[]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

CreateExpanded
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes: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 do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

CreateExpanded
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-CheckWorkspaceAlertsStorageConfigured

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.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

CreateExpanded
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-CriterionAllOf

Uma lista de condições a serem avaliadas em relação aos escopos especificados

Propriedades do parâmetro

Tipo:

ICondition[]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

CreateExpanded
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-DefaultProfile

O parâmetro DefaultProfile não está funcional. Use o parâmetro SubscriptionId quando disponível se estiver executando o cmdlet em uma assinatura diferente.

Propriedades do parâmetro

Tipo:PSObject
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Description

A descrição da regra de consulta agendada.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

CreateExpanded
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-DisplayName

O nome de exibição da regra de alerta

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

CreateExpanded
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Enabled

O sinalizador que indica se essa regra de consulta agendada está habilitada. O valor deve ser verdadeiro ou falso

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

CreateExpanded
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-EvaluationFrequency

Com que frequência a regra de consulta agendada é avaliada representada no formato de duração iso 8601. Relevante e necessário somente para regras do tipo LogAlert.

Propriedades do parâmetro

Tipo:TimeSpan
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

CreateExpanded
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-JsonFilePath

Caminho do arquivo Json fornecido para a operação Create

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

CreateViaJsonFilePath
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-JsonString

Cadeia de caracteres Json fornecida para a operação Create

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

CreateViaJsonString
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Kind

Indica o tipo de regra de consulta agendada. O padrão é LogAlert.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

CreateExpanded
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Location

A localização geográfica onde o recurso reside

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

CreateExpanded
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-MuteActionsDuration

Ações de mudo para o período de tempo escolhido (no formato de duração ISO 8601) depois que o alerta é acionado. Relevante apenas para regras do tipo LogAlert.

Propriedades do parâmetro

Tipo:TimeSpan
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

CreateExpanded
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Name

O nome da regra.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-OverrideQueryTimeRange

Se especificado, substitui o intervalo de tempo da consulta (o padrão é WindowSize*NumberOfEvaluationPeriods). Relevante apenas para regras do tipo LogAlert.

Propriedades do parâmetro

Tipo:TimeSpan
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

CreateExpanded
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ResourceGroupName

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Scope

A lista de IDs de recurso à qual essa regra de consulta agendada está no escopo.

Propriedades do parâmetro

Tipo:

String[]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

CreateExpanded
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Severity

Gravidade do alerta. Deve ser um inteiro entre [0-4]. O valor de 0 é mais severo. Relevante e necessário somente para regras do tipo LogAlert.

Propriedades do parâmetro

Tipo:Int64
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

CreateExpanded
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes: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 do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

CreateExpanded
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-SubscriptionId

A ID da assinatura de destino.

Propriedades do parâmetro

Tipo:String
Valor padrão:(Get-AzContext).Subscription.Id
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Tag

Tags de recursos.

Propriedades do parâmetro

Tipo:Hashtable
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

CreateExpanded
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-TargetResourceType

Lista do tipo de recurso dos recursos de destino nos quais o alerta é criado/atualizado. Por exemplo, se o escopo for um grupo de recursos e targetResourceTypes for Microsoft.Compute/virtualMachines, um alerta diferente será disparado para cada máquina virtual no grupo de recursos que atenda aos critérios de alerta. Relevante apenas para regras do tipo LogAlert

Propriedades do parâmetro

Tipo:

String[]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

CreateExpanded
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WhatIf

Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WindowSize

O período de tempo (no formato de duração ISO 8601) no qual a consulta alerta será executada (tamanho da lixeira). Relevante e necessário somente para regras do tipo LogAlert.

Propriedades do parâmetro

Tipo:TimeSpan
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

CreateExpanded
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes: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

IScheduledQueryRuleResource