Compartir a través de

az monitor scheduled-query

  • Referencia

Nota:

Esta referencia forma parte de la extensión scheduled-query para la CLI de Azure (versión 2.54.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az monitor scheduled-query . Obtenga más información sobre las extensiones.

Comandos para administrar consultas programadas.

Comandos

Nombre Description Tipo Estado
az monitor scheduled-query create

Cree una consulta programada.

 Extensión GA
az monitor scheduled-query delete

Elimine una consulta programada.

 Extensión GA
az monitor scheduled-query list

Enumera todas las consultas programadas.

 Extensión GA
az monitor scheduled-query show

Mostrar detalles de una consulta programada.

 Extensión GA
az monitor scheduled-query update

Actualizar una consulta programada.

 Extensión GA

az monitor scheduled-query create

Cree una consulta programada.

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]

Ejemplos

Cree una consulta programada para una máquina virtual.

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"

Cree una consulta programada para máquinas virtuales en un 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 requeridos

--condition

Condición que desencadena la regla.

Uso: --condition {avg,min,max,total,count} ["METRIC COLUMN" from] "QUERY_PLACEHOLDER" {=,!=,>>,=,<,<=} THRESHOLD [resource id RESOURCEID] [where DIMENSION {includes,excludes} VALUE [or VALUE ...] [y DIMENSION {includes,excludes} VALUE [or VALUE ...] ...]] [al menos minTimeToFail infracciones fuera de los puntos agregados EvaluationPeriod]" Los marcadores de posición de consulta se pueden definir en el argumento --condition-query Dimensions se pueden consultar agregando la palabra clave "where" y varias dimensiones se pueden consultar mediante la combinación con la palabra clave "and".

--name -n

Nombre de la regla de consulta programada.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--scopes

Lista separada por espacios de ámbitos a los que se aplica la regla. Los recursos especificados en este parámetro deben ser del mismo tipo y existir en la misma ubicación.

Parámetros opcionales

--action-groups

Identificadores de recurso del grupo de acciones que se invocarán cuando se active la alerta.

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

--auto-mitigate

Marca que indica si la alerta se debe resolver automáticamente o no. El valor predeterminado es true.

Valores aceptados: false, true
Valor predeterminado: True
--check-ws-alerts-storage --cwas

Marca que indica si esta regla de consulta programada debe almacenarse en el almacenamiento del cliente.

Valores aceptados: false, true
Valor predeterminado: False
--condition-query

Consulta deteils para reemplazar los marcadores de posición en --condition el argumento .

--custom-properties

Propiedades de una carga de alerta.

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

--description

Descripción de texto libre de la regla.

--disabled

Deshabilite la consulta programada.

Valores aceptados: false, true
Valor predeterminado: False
--evaluation-frequency

Frecuencia con la que se va a evaluar la regla en formato "##h##m##s".

Valor predeterminado: 5m
--location -l

Ubicación. Los valores de: az account list-locations. Puede configurar la ubicación predeterminada mediante az configure --defaults location=<location>.

--mad --mute-actions-duration

Silenciar acciones durante el período de tiempo elegido (en formato de duración ISO 8601) después de activar la alerta.

--severity

Gravedad de la alerta de 0 (crítico) a 4 (detallado).

Valor predeterminado: 2
--skip-query-validation

Marca que indica si se debe validar o no la consulta proporcionada.

Valores aceptados: false, true
Valor predeterminado: False
--tags

Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.

--target-resource-type --type

Tipo de recurso de los recursos de destino en ámbitos. Esto debe proporcionarse cuando los ámbitos son grupos de recursos o suscripción.

--window-size

Tiempo con el que agregar métricas en formato "##h##m##s".

Valor predeterminado: 5m
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az monitor scheduled-query delete

Elimine una consulta programada.

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

Parámetros opcionales

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--name -n

Nombre de la regla de consulta programada.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--yes -y

No solicita confirmación.

Valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az monitor scheduled-query list

Enumera todas las consultas programadas.

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

Parámetros opcionales

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az monitor scheduled-query show

Mostrar detalles de una consulta programada.

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

Parámetros opcionales

--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--name -n

Nombre de la regla de consulta programada.

--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.

az monitor scheduled-query update

Actualizar una consulta programada.

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 opcionales

--action-groups

Identificadores de recurso del grupo de acciones que se invocarán cuando se active la alerta.

--add

Agregue un objeto a una lista de objetos especificando una ruta de acceso y pares clave-valor. Ejemplo: --add property.listProperty <key=value, string or JSON string>.

Valor predeterminado: []
--auto-mitigate

Marca que indica si la alerta se debe resolver automáticamente o no. El valor predeterminado es true.

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

Marca que indica si esta regla de consulta programada debe almacenarse en el almacenamiento del cliente.

Valores aceptados: false, true
--condition

Condición que desencadena la regla.

Uso: --condition {avg,min,max,total,count} ["METRIC COLUMN" from] "QUERY_PLACEHOLDER" {=,!=,>>,=,<,<=} THRESHOLD [resource id RESOURCEID] [where DIMENSION {includes,excludes} VALUE [or VALUE ...] [y DIMENSION {includes,excludes} VALUE [or VALUE ...] ...]] [al menos infracciones de MinTimeToFail fuera de los puntos agregados EvaluationPeriod]'

Los marcadores de posición de consulta se pueden definir en el argumento --condition-query Dimensiones se pueden consultar agregando la palabra clave "where" y se pueden consultar varias dimensiones mediante la combinación con la palabra clave "and".

--condition-query

Consulta deteils para reemplazar los marcadores de posición en --condition el argumento .

--custom-properties

Propiedades de una carga de alerta.

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

--description

Descripción de texto libre de la regla.

--disabled

Deshabilite la consulta programada.

Valores aceptados: false, true
--evaluation-frequency

Frecuencia con la que se va a evaluar la regla en formato "##h##m##s".

--force-string

Al usar 'set' o 'add', conserve los literales de cadena en lugar de intentar convertir en JSON.

Valor predeterminado: False
--ids

Uno o varios identificadores de recursos (delimitados por espacios). Debe ser un identificador de recurso completo que contenga toda la información de los argumentos "Resource Id". Debe proporcionar argumentos --ids u otros argumentos "Resource Id".

--mad --mute-actions-duration

Silenciar acciones durante el período de tiempo elegido (en formato de duración ISO 8601) después de activar la alerta.

--name -n

Nombre de la regla de consulta programada.

--remove

Quite una propiedad o un elemento de una lista. Ejemplo: --remove property.list <indexToRemove> O --remove propertyToRemove.

Valor predeterminado: []
--resource-group -g

Nombre del grupo de recursos. Puede configurar el grupo predeterminado mediante az configure --defaults group=<name>.

--set

Actualice un objeto especificando una ruta de acceso de propiedad y un valor que se va a establecer. Ejemplo: --set property1.property2=<value>.

Valor predeterminado: []
--severity

Gravedad de la alerta de 0 (crítico) a 4 (detallado).

--skip-query-validation

Marca que indica si se debe validar o no la consulta proporcionada.

Valores aceptados: false, true
--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--tags

Etiquetas separadas por espacios: key[=value] [key[=value] ...]. Use "" para borrar las etiquetas existentes.

--target-resource-type --type

Tipo de recurso de los recursos de destino en ámbitos. Esto debe proporcionarse cuando los ámbitos son grupos de recursos o suscripción.

--window-size

Tiempo con el que agregar métricas en formato "##h##m##s".

Parámetros globales
--debug

Aumente el nivel de detalle de registro para mostrar todos los registros de depuración.

--help -h

Muestre este mensaje de ayuda y salga.

--only-show-errors

Mostrar solo los errores y suprimir las advertencias.

--output -o

Formato de salida.

Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
Valor predeterminado: json
--query

Cadena de consulta de JMESPath. Para más información y ejemplos, consulte http://jmespath.org/.

--subscription

Nombre o identificador de la suscripción Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle de registro. Use --debug para obtener registros de depuración completos.