az grafana dashboard

  • Referencia

Nota:

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

Comandos para administrar paneles de una instancia.

Comandos

Nombre Description Tipo Estado
az grafana dashboard create

Cree un nuevo panel.

 Extensión GA
az grafana dashboard delete

Eliminar un panel.

 Extensión GA
az grafana dashboard import

Importe un panel.

 Extensión GA
az grafana dashboard list

Enumere todos los paneles de una instancia.

 Extensión GA
az grafana dashboard show

Obtenga los detalles de un panel.

 Extensión GA
az grafana dashboard sync

Sincronice los paneles de Azure Managed Grafana de una instancia a otra. Tenga en cuenta que los paneles con estado "aprovisionado" se omitirán debido a que son de solo lectura.

 Extensión Vista previa
az grafana dashboard update

Actualizar un panel.

 Extensión GA

az grafana dashboard create

Cree un nuevo panel.

az grafana dashboard create --definition
                            --name
                            [--api-key]
                            [--folder]
                            [--overwrite {false, true}]
                            [--resource-group]
                            [--title]

Ejemplos

Cree un panel con definición en un archivo JSON. Para el inicio rápido, clone desde la salida de "az grafana dashboard show", quite "id" y "uid" y aplique cambios.

az grafana dashboard create -g MyResourceGroup -n MyGrafana --title "My dashboard" --folder folder1 --definition '{
  "dashboard": {
    "annotations": {
        ...
    },
    "panels": {
        ...
    }
  },
  "message": "Create a new test dashboard"
}'

Parámetros requeridos

--definition

Modelo de panel completo en cadena json, una ruta de acceso o una dirección URL a un archivo con dicho contenido.

--name -n

Nombre de Azure Managed Grafana.

Parámetros opcionales

--api-key --token -t

Clave de API o token de cuenta de servicio, una cadena generada aleatoriamente que se usa para interactuar con el punto de conexión de Grafana; Si falta, la CLI usará las credenciales del usuario que ha iniciado sesión.

--folder

Identificador, uid, título que puede identificar una carpeta. La CLI buscará en el orden de id, uid y title, hasta que encuentre una coincidencia.

--overwrite

Sobrescriba un panel con la misma interfaz de usuario.

valores aceptados: false, true
--resource-group -g

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

--title

Título de un panel.

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 grafana dashboard delete

Eliminar un panel.

az grafana dashboard delete --dashboard
                            --name
                            [--api-key]
                            [--resource-group]

Ejemplos

Elimine un panel especificado por un identificador único(use el comando "az grafana dashboard list" para recuperar el uid).

az grafana dashboard delete -g MyResourceGroup -n MyGrafana --dashboard VdrOA7jGz

Parámetros requeridos

--dashboard

Interfaz de usuario del panel.

--name -n

Nombre de Azure Managed Grafana.

Parámetros opcionales

--api-key --token -t

Clave de API o token de cuenta de servicio, una cadena generada aleatoriamente que se usa para interactuar con el punto de conexión de Grafana; Si falta, la CLI usará las credenciales del usuario que ha iniciado sesión.

--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 grafana dashboard import

Importe un panel.

El comando de la CLI rellenará los parámetros necesarios para los orígenes de datos si está configurado.

az grafana dashboard import --definition
                            --name
                            [--api-key]
                            [--folder]
                            [--overwrite {false, true}]
                            [--resource-group]

Ejemplos

importe el panel de "AKS Container Ideas" desde la galería de Grafana.

az grafana dashboard import -g MyResourceGroup -n MyGrafana --definition 12180

importar un panel desde un archivo.

az grafana dashboard import -g MyResourceGroup -n MyGrafana --definition @c:\temp\dashboard.json

Parámetros requeridos

--definition

Modelo de panel completo en cadena json, identificador de la galería de Grafana, una ruta de acceso o una dirección URL a un archivo con dicho contenido.

--name -n

Nombre de Azure Managed Grafana.

Parámetros opcionales

--api-key --token -t

Clave de API o token de cuenta de servicio, una cadena generada aleatoriamente que se usa para interactuar con el punto de conexión de Grafana; Si falta, la CLI usará las credenciales del usuario que ha iniciado sesión.

--folder

Identificador, uid, título que puede identificar una carpeta. La CLI buscará en el orden de id, uid y title, hasta que encuentre una coincidencia.

--overwrite

Sobrescriba un panel con la misma interfaz de usuario.

valores aceptados: false, true
--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 grafana dashboard list

Enumere todos los paneles de una instancia.

az grafana dashboard list --name
                          [--api-key]
                          [--resource-group]

Ejemplos

Busque el panel del servidor de API K8s y recupere el identificador único (para invocar el comando "az grafana dashboard show")

az grafana dashboard list -g MyResourceGroup -n MyGrafana --query "[?contains(@.title, 'API server')].uid"

Parámetros requeridos

--name -n

Nombre de Azure Managed Grafana.

Parámetros opcionales

--api-key --token -t

Clave de API o token de cuenta de servicio, una cadena generada aleatoriamente que se usa para interactuar con el punto de conexión de Grafana; Si falta, la CLI usará las credenciales del usuario que ha iniciado sesión.

--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 grafana dashboard show

Obtenga los detalles de un panel.

az grafana dashboard show --dashboard
                          --name
                          [--api-key]
                          [--resource-group]

Ejemplos

Obtener detalles de un panel especificado por un identificador único (use el comando "az grafana dashboard list" para recuperar el uid)

az grafana dashboard show -g MyResourceGroup -n MyGrafana --dashboard VdrOA7jGz

Parámetros requeridos

--dashboard

Interfaz de usuario del panel.

--name -n

Nombre de Azure Managed Grafana.

Parámetros opcionales

--api-key --token -t

Clave de API o token de cuenta de servicio, una cadena generada aleatoriamente que se usa para interactuar con el punto de conexión de Grafana; Si falta, la CLI usará las credenciales del usuario que ha iniciado sesión.

--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 grafana dashboard sync

Vista previa

Este comando está en versión preliminar y en desarrollo. Niveles de referencia y soporte técnico: https://aka.ms/CLI_refstatus

Sincronice los paneles de Azure Managed Grafana de una instancia a otra. Tenga en cuenta que los paneles con estado "aprovisionado" se omitirán debido a que son de solo lectura.

az grafana dashboard sync --destination
                          --source
                          [--dashboards-to-exclude]
                          [--dashboards-to-include]
                          [--dry-run {false, true}]
                          [--folders-to-exclude]
                          [--folders-to-include]

Ejemplos

Sincronizar solo paneles en algunas carpetas

az grafana dashboard sync --source /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/source --destination /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/destination --folders-to-include "Azure Monitor Container Insights" "Azure Monitor"

Sincronización de un único panel

az grafana dashboard sync --source /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/source --destination /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/destination --folders-to-include "MyFolder" --dashboards-to-include "My Service Health"

Vista previa de la sincronización

az grafana dashboard sync --source /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/source --destination /subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspaces/providers/Microsoft.Dashboard/grafana/destination --dry-run

Parámetros requeridos

--destination -d

Identificador de recurso del área de trabajo de destino.

--source -s

Identificador de recurso del área de trabajo de origen.

Parámetros opcionales

--dashboards-to-exclude

Títulos separados por espacios de paneles que se van a excluir sincronizados. Empareja con --folders-to-exclude para carpetas específicas.

--dashboards-to-include

Títulos separados por espacios de paneles que se van a incluir sincronizados. Empareja con --folders-to-include para carpetas específicas.

--dry-run

Vista previa de los cambios con confirmación.

valores aceptados: false, true
--folders-to-exclude -e

Carpetas que se excluirán en la copia de seguridad o sincronización.

--folders-to-include -i

Carpetas que se van a incluir en la copia de seguridad o sincronización.

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 grafana dashboard update

Actualizar un panel.

az grafana dashboard update --definition
                            --name
                            [--api-key]
                            [--folder]
                            [--overwrite {false, true}]
                            [--resource-group]

Ejemplos

Actualice un panel con definición en un archivo json. Para obtener el inicio rápido, obtenga la configuración existente de "az grafana dashboard show" y aplique los cambios. El campo "version" debe actualizarse y el campo "overwrite" debe ser true.

az grafana dashboard update -g MyResourceGroup -n MyGrafana --definition @c:\temp\dashboard.json

Parámetros requeridos

--definition

Modelo de panel completo en cadena json, una ruta de acceso o una dirección URL a un archivo con dicho contenido.

--name -n

Nombre de Azure Managed Grafana.

Parámetros opcionales

--api-key --token -t

Clave de API o token de cuenta de servicio, una cadena generada aleatoriamente que se usa para interactuar con el punto de conexión de Grafana; Si falta, la CLI usará las credenciales del usuario que ha iniciado sesión.

--folder

Identificador, uid, título que puede identificar una carpeta. La CLI buscará en el orden de id, uid y title, hasta que encuentre una coincidencia.

--overwrite

Sobrescriba un panel con la misma interfaz de usuario.

valores aceptados: false, true
--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.