Compartilhar via

az monitor scheduled-query

  • Referência

Observação

Essa referência faz parte da extensão de consulta agendada para a CLI do Azure (versão 2.54.0 ou superior). A extensão será instalada automaticamente na primeira vez que você executar um comando az monitor scheduled-query . Saiba mais sobre extensões.

Comandos para gerenciar consultas agendadas.

Comandos

Nome Description Tipo Status
az monitor scheduled-query create

Crie uma consulta agendada.

 Extensão GA
az monitor scheduled-query delete

Excluir uma consulta agendada.

 Extensão GA
az monitor scheduled-query list

Listar todas as consultas agendadas.

 Extensão GA
az monitor scheduled-query show

Mostrar detalhes de uma consulta agendada.

 Extensão GA
az monitor scheduled-query update

Atualizar uma consulta agendada.

 Extensão GA

az monitor scheduled-query create

Crie uma consulta agendada.

az monitor scheduled-query create --condition
                                  --name
                                  --resource-group
                                  --scopes
                                  [--action-groups]
                                  [--auto-mitigate {false, true}]
                                  [--check-ws-alerts-storage {false, true}]
                                  [--condition-query]
                                  [--custom-properties]
                                  [--description]
                                  [--disabled {false, true}]
                                  [--evaluation-frequency]
                                  [--location]
                                  [--mad]
                                  [--severity]
                                  [--skip-query-validation {false, true}]
                                  [--tags]
                                  [--target-resource-type]
                                  [--window-size]

Exemplos

Crie uma consulta agendada para uma VM.

az monitor scheduled-query create -g {rg} -n {name1} --scopes {vm_id} --condition "count 'Placeholder_1' > 360 resource id _ResourceId at least 1 violations out of 5 aggregated points" --condition-query Placeholder_1="union Event, Syslog | where TimeGenerated > ago(1h) | where EventLevelName=='Error' or SeverityLevel=='err'" --description "Test rule"

Crie uma consulta agendada para VMs em um grupo de recursos.

az monitor scheduled-query create -g {rg} -n {name1} --scopes {rg_id} --condition "count 'Placeholder_1' > 360 resource id _ResourceId at least 1 violations out of 5 aggregated points" --condition-query Placeholder_1="union Event, Syslog | where TimeGenerated > ago(1h) | where EventLevelName=='Error' or SeverityLevel=='err'" --description "Test rule"

Parâmetros Exigidos

--condition

A condição que aciona a regra.

Uso: --condition {avg,min,max,total,count} ["METRIC COLUMN" from] "QUERY_PLACEHOLDER" {=,!=,>>,=,<<,=} THRESHOLD [resource id RESOURCEID] [onde DIMENSION {includes,excludes} VALUE [or VALUE ...] [e DIMENSÃO {inclui,exclui} VALOR [ou VALOR ...] ...]] [pelo menos violações MinTimeToFail fora dos pontos agregados EvaluationPeriod]' Os espaços reservados de consulta podem ser definidos no argumento --condition-query As dimensões podem ser consultadas adicionando a palavra-chave 'where' e várias dimensões podem ser consultadas combinando-as com a palavra-chave 'and'.

--name -n

Nome da regra de consulta agendada.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--scopes

Lista separada por espaço de escopos aos quais a regra se aplica. Os recursos especificados neste parâmetro devem ser do mesmo tipo e existir no mesmo local.

Parâmetros Opcionais

--action-groups

Ids de recurso do Grupo de Ação a serem invocados quando o alerta for acionado.

Uso: --action-groups ACTION_GROUP_NAME_OR_ID [NAME_OR_ID,...].

--auto-mitigate

O sinalizador que indica se o alerta deve ser resolvido automaticamente ou não. O padrão é true.

Valores aceitos: false, true
Valor padrão: True
--check-ws-alerts-storage --cwas

O sinalizador que indica se essa regra de consulta agendada deve ser armazenada no armazenamento do cliente.

Valores aceitos: false, true
Valor padrão: False
--condition-query

A consulta deteils para substituir os espaços reservados no --condition argumento.

--custom-properties

As propriedades de uma carga de alerta.

Uso: --custom-properties ALERT_PAYLOAD_PROPERTIES [KEY=VAL,KEY=VAL ...].

--description

Descrição em texto livre da regra.

--disabled

Desative a consulta agendada.

Valores aceitos: false, true
Valor padrão: False
--evaluation-frequency

Frequência com a qual avaliar a regra no formato "##h##m##s".

Valor padrão: 5m
--location -l

Local. Valores de: az account list-locations. Você pode configurar o local padrão usando az configure --defaults location=<location>.

--mad --mute-actions-duration

Silencie ações para o período de tempo escolhido (no formato de duração ISO 8601) depois que o alerta for disparado.

--severity

Gravidade do alerta de 0 (crítico) a 4 (detalhado).

Valor padrão: 2
--skip-query-validation

O sinalizador que indica se a consulta fornecida deve ser validada ou não.

Valores aceitos: false, true
Valor padrão: False
--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar as tags existentes.

--target-resource-type --type

O tipo de recurso do(s) recurso(s) de destino em escopos. Isso deve ser fornecido quando o escopo é grupo de recursos ou assinatura.

--window-size

Tempo para agregar métricas no formato "##h##m##s".

Valor padrão: 5m
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az monitor scheduled-query delete

Excluir uma consulta agendada.

az monitor scheduled-query delete [--ids]
                                  [--name]
                                  [--resource-group]
                                  [--subscription]
                                  [--yes]

Parâmetros Opcionais

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de "ID do recurso". Você deve fornecer --ids ou outros argumentos de "ID do recurso".

--name -n

Nome da regra de consulta agendada.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--yes -y

Não solicite confirmação.

Valor padrão: False
Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az monitor scheduled-query list

Listar todas as consultas agendadas.

az monitor scheduled-query list [--resource-group]

Parâmetros Opcionais

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az monitor scheduled-query show

Mostrar detalhes de uma consulta agendada.

az monitor scheduled-query show [--ids]
                                [--name]
                                [--resource-group]
                                [--subscription]

Parâmetros Opcionais

--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de "ID do recurso". Você deve fornecer --ids ou outros argumentos de "ID do recurso".

--name -n

Nome da regra de consulta agendada.

--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.

az monitor scheduled-query update

Atualizar uma consulta agendada.

az monitor scheduled-query update [--action-groups]
                                  [--add]
                                  [--auto-mitigate {false, true}]
                                  [--check-ws-alerts-storage {false, true}]
                                  [--condition]
                                  [--condition-query]
                                  [--custom-properties]
                                  [--description]
                                  [--disabled {false, true}]
                                  [--evaluation-frequency]
                                  [--force-string]
                                  [--ids]
                                  [--mad]
                                  [--name]
                                  [--remove]
                                  [--resource-group]
                                  [--set]
                                  [--severity]
                                  [--skip-query-validation {false, true}]
                                  [--subscription]
                                  [--tags]
                                  [--target-resource-type]
                                  [--window-size]

Parâmetros Opcionais

--action-groups

Ids de recurso do Grupo de Ação a serem invocados quando o alerta for acionado.

--add

Adicione um objeto a uma lista de objetos especificando um caminho e pares de valores de chave. Exemplo: --add property.listProperty <key=value, string or JSON string>.

Valor padrão: []
--auto-mitigate

O sinalizador que indica se o alerta deve ser resolvido automaticamente ou não. O padrão é true.

Valores aceitos: false, true
--check-ws-alerts-storage --cwas

O sinalizador que indica se essa regra de consulta agendada deve ser armazenada no armazenamento do cliente.

Valores aceitos: false, true
--condition

A condição que aciona a regra.

Uso: --condition {avg,min,max,total,count} ["METRIC COLUMN" from] "QUERY_PLACEHOLDER" {=,!=,>>,=,<<,=} THRESHOLD [resource id RESOURCEID] [onde DIMENSION {includes,excludes} VALUE [or VALUE ...] [e DIMENSÃO {inclui,exclui} VALOR [ou VALOR ...] ...]] [pelo menos violações MinTimeToFail fora dos pontos agregados do Período de Avaliação]'

Os espaços reservados de consulta podem ser definidos no argumento --condition-query As dimensões podem ser consultadas adicionando a palavra-chave 'where' e várias dimensões podem ser consultadas combinando-as com a palavra-chave 'and'.

--condition-query

A consulta deteils para substituir os espaços reservados no --condition argumento.

--custom-properties

As propriedades de uma carga de alerta.

Uso: --custom-properties ALERT_PAYLOAD_PROPERTIES [KEY=VAL,KEY=VAL ...].

--description

Descrição em texto livre da regra.

--disabled

Desative a consulta agendada.

Valores aceitos: false, true
--evaluation-frequency

Frequência com a qual avaliar a regra no formato "##h##m##s".

--force-string

Ao usar 'set' ou 'add', preserve literais de cadeia de caracteres em vez de tentar converter para JSON.

Valor padrão: False
--ids

Uma ou mais IDs de recurso (delimitadas por espaço). Deve ser uma ID de recurso completa que contém todas as informações de argumentos de "ID do recurso". Você deve fornecer --ids ou outros argumentos de "ID do recurso".

--mad --mute-actions-duration

Silencie ações para o período de tempo escolhido (no formato de duração ISO 8601) depois que o alerta for disparado.

--name -n

Nome da regra de consulta agendada.

--remove

Remova uma propriedade ou um elemento de uma lista. Exemplo: --remove property.list <indexToRemove> OU --remove propertyToRemove.

Valor padrão: []
--resource-group -g

Nome do grupo de recursos. Você pode configurar o grupo padrão usando az configure --defaults group=<name>.

--set

Atualize um objeto especificando um caminho de propriedade e um valor a serem definidos. Exemplo: --set property1.property2=<value>.

Valor padrão: []
--severity

Gravidade do alerta de 0 (crítico) a 4 (detalhado).

--skip-query-validation

O sinalizador que indica se a consulta fornecida deve ser validada ou não.

Valores aceitos: false, true
--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--tags

Tags separadas por espaço: key[=value] [key[=value] ...]. Use "" para limpar as tags existentes.

--target-resource-type --type

O tipo de recurso do(s) recurso(s) de destino em escopos. Isso deve ser fornecido quando o escopo é grupo de recursos ou assinatura.

--window-size

Tempo para agregar métricas no formato "##h##m##s".

Parâmetros Globais
--debug

Aumente o detalhamento do log para mostrar todos os logs de depuração.

--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

--output -o

Formato de saída.

Valores aceitos: json, jsonc, none, table, tsv, yaml, yamlc
Valor padrão: json
--query

Cadeia de caracteres de consulta JMESPath. Consulte http://jmespath.org/ para obter mais informações e exemplos.

--subscription

Nome ou ID da assinatura. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_ID.

--verbose

Aumentar o detalhamento do log. Use --debug para logs de depuração completos.