Partilhar via

az monitor scheduled-query

  • Referência

Nota

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

Name 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

Liste 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 Obrigatórios

--condition

A condição que desencadeia 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 para 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

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

--scopes

Lista separada por espaços dos 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ções para invocar 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 aceites: false, true
Default value: True
--check-ws-alerts-storage --cwas

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

Valores aceites: false, true
Default value: False
--condition-query

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

--custom-properties

As propriedades de uma carga útil 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 aceites: false, true
Default value: False
--evaluation-frequency

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

Default value: 5m
--location -l

Localização. 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 pelo período de tempo escolhido (no formato de duração ISO 8601) depois que o alerta for acionado.

--severity

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

Default value: 2
--skip-query-validation

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

Valores aceites: false, true
Default value: False
--tags

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

--target-resource-type --type

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

--window-size

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

Default value: 5m
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name -n

Nome da regra de consulta agendada.

--resource-group -g

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--yes -y

Não solicite confirmação.

Default value: False
Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.

az monitor scheduled-query list

Liste todas as consultas agendadas.

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

Parâmetros Opcionais

--resource-group -g

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--name -n

Nome da regra de consulta agendada.

--resource-group -g

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. 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ções para invocar quando o alerta for acionado.

--add

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

Default value: []
--auto-mitigate

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

Valores aceites: 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 aceites: false, true
--condition

A condição que desencadeia 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 EvaluationPeriod]»

Os espaços reservados para 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

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

--custom-properties

As propriedades de uma carga útil 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 aceites: false, true
--evaluation-frequency

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

--force-string

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

Default value: False
--ids

Um ou mais IDs de recurso (delimitados por espaço). Deve ser um ID de recurso completo contendo todas as informações dos argumentos 'ID do recurso'. Você deve fornecer --ids ou outros argumentos 'Resource Id'.

--mad --mute-actions-duration

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

--name -n

Nome da regra de consulta agendada.

--remove

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

Default value: []
--resource-group -g

o 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 ser definido. Exemplo: --set property1.property2=<value>.

Default value: []
--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 aceites: false, true
--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--tags

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

--target-resource-type --type

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

--window-size

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

Parâmetros de Globais
--debug

Aumente a verbosidade 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 aceites: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

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

--subscription

o nome ou o ID da subscrição. Você pode configurar a assinatura padrão usando az account set -s NAME_OR_IDo .

--verbose

Aumente a verbosidade do registro. Use --debug para logs de depuração completos.