Partilhar via

az monitor scheduled-query

Note

Esta referência faz parte da extensão scheduled-query para o 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.

 Extension disponibilidade geral
az monitor scheduled-query delete

Excluir uma consulta agendada.

 Extension disponibilidade geral
az monitor scheduled-query list

Liste todas as consultas agendadas.

 Extension disponibilidade geral
az monitor scheduled-query show

Mostrar detalhes de uma consulta agendada.

 Extension disponibilidade geral
az monitor scheduled-query update

Atualizar uma consulta agendada.

 Extension disponibilidade geral

az monitor scheduled-query create

Crie uma consulta agendada.

az monitor scheduled-query create --condition
                                  --name
                                  --resource-group
                                  --scopes
                                  [--acquire-policy-token]
                                  [--action-groups]
                                  [--auto-mitigate {false, true}]
                                  [--change-reference]
                                  [--check-ws-alerts-storage --cwas {false, true}]
                                  [--condition-query]
                                  [--custom-properties]
                                  [--description]
                                  [--disabled {false, true}]
                                  [--evaluation-frequency]
                                  [--location]
                                  [--mad --mute-actions-duration]
                                  [--severity]
                                  [--skip-query-validation {false, true}]
                                  [--tags]
                                  [--target-resource-type --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

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

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--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 é verdadeiro.

Propriedade Valor
Default value: True
Valores aceites: false, true
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--check-ws-alerts-storage --cwas

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

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

Consulta deteils para substituir os espaços reservados em --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.

Propriedade Valor
Default value: False
Valores aceites: false, true
--evaluation-frequency

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

Propriedade Valor
Default value: 5m
--location -l

Location. 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).

Propriedade Valor
Default value: 2
--skip-query-validation

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

Propriedade Valor
Default value: False
Valores aceites: false, true
--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".

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

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az monitor scheduled-query delete

Excluir uma consulta agendada.

az monitor scheduled-query delete [--acquire-policy-token]
                                  [--change-reference]
                                  [--ids]
                                  [--name]
                                  [--resource-group]
                                  [--subscription]
                                  [--yes]

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

Nome da regra de consulta agendada.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--yes -y

Não solicite confirmação.

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

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Propriedade Valor
Default value: False

az monitor scheduled-query list

Liste todas as consultas agendadas.

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--resource-group -g

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.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--subscription

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

--verbose

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

Propriedade Valor
Default value: False

az monitor scheduled-query show

Mostrar detalhes de uma consulta agendada.

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--name -n

Nome da regra de consulta agendada.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
Parâmetros de Globais
--debug

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

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Propriedade Valor
Default value: False

az monitor scheduled-query update

Atualizar uma consulta agendada.

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

Parâmetros Opcionais

Os seguintes parâmetros são opcionais, mas dependendo do contexto, um ou mais podem tornar-se necessários para que o comando seja executado com êxito.

--acquire-policy-token

Aquisição automática de um token Azure Policy para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--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>.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Default value: []
--auto-mitigate

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

Propriedade Valor
Valores aceites: false, true
--change-reference

O ID de referência de alteração relacionado para esta operação de recurso.

Propriedade Valor
Grupo de parâmetros: Global Policy Arguments
--check-ws-alerts-storage --cwas

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

Propriedade Valor
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 em --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.

Propriedade Valor
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.

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Default value: False
--ids

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--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.

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--remove

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
Default value: []
--resource-group -g

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--set

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

Propriedade Valor
Grupo de parâmetros: Generic Update Arguments
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.

Propriedade Valor
Valores aceites: false, true
--subscription

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

Propriedade Valor
Grupo de parâmetros: Resource Id Arguments
--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.

Propriedade Valor
Default value: False
--help -h

Mostrar esta mensagem de ajuda e sair.

--only-show-errors

Mostrar apenas erros, suprimindo avisos.

Propriedade Valor
Default value: False
--output -o

Formato de saída.

Propriedade Valor
Default value: json
Valores aceites: json, jsonc, none, table, tsv, yaml, yamlc
--query

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

--verbose

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

Propriedade Valor
Default value: False