Поделиться через

az grafana dashboard

Note

This reference is part of the amg extension for the Azure CLI (version 2.61.0 or higher). Расширение будет автоматически устанавливаться при первом запуске команды az grafana dashboard. Learn more about extensions.

Команды для управления панелями мониторинга экземпляра.

Команды

Имя Описание Тип Состояние
az grafana dashboard create

Создайте новую панель мониторинга.

 Extension GA
az grafana dashboard delete

Удаление панели мониторинга.

 Extension GA
az grafana dashboard import

Импорт панели мониторинга.

 Extension GA
az grafana dashboard list

Вывод списка всех панелей мониторинга экземпляра.

 Extension GA
az grafana dashboard show

Получение сведений о панели мониторинга.

 Extension GA
az grafana dashboard sync

Синхронизация панелей мониторинга Azure Managed Grafana из одного экземпляра в другой экземпляр. Панели библиотеки на панелях мониторинга будут автоматически включены в синхронизацию. Обратите внимание, что панели мониторинга с состоянием "Подготовлено" будут пропущены из-за того, что они доступны только для чтения.

 Extension Preview
az grafana dashboard update

Обновите панель мониторинга.

 Extension GA

az grafana dashboard create

Создайте новую панель мониторинга.

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

Примеры

Создайте панель мониторинга с определением в json-файле. Для быстрого запуска клонируйте данные из выходных данных az grafana dashboard show, удалите "id" и uid и примените изменения.

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

Обязательные параметры

--definition

Полная модель панели мониторинга в строке JSON, путь или URL-адрес файла с таким содержимым.

--name -n

Имя Управляемой Grafana в Azure.

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-key --token -t

Ключ API или маркер учетной записи службы, случайно созданная строка, используемая для взаимодействия с конечной точкой Grafana; Если отсутствует, интерфейс командной строки будет использовать учетные данные текущего пользователя, вошедшего в систему.

--folder

Uid или title, которые могут идентифицировать папку. ИНТЕРФЕЙС командной строки сначала будет выполнять поиск по пользовательскому интерфейсу, а затем заголовок, пока он не находит совпадение.

--overwrite

Перезапись панели мониторинга с одинаковым пользовательским интерфейсом.

Свойство Значение
Допустимые значения: false, true
--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

--title

Заголовок панели мониторинга.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Output format.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az grafana dashboard delete

Удаление панели мониторинга.

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

Примеры

Удаление панели мониторинга, указанной уникальным идентификатором (используйте команду az grafana dashboard list для получения пользовательского интерфейса)

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

Обязательные параметры

--dashboard

Dashboard uid.

--name -n

Имя Управляемой Grafana в Azure.

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-key --token -t

Ключ API или маркер учетной записи службы, случайно созданная строка, используемая для взаимодействия с конечной точкой Grafana; Если отсутствует, интерфейс командной строки будет использовать учетные данные текущего пользователя, вошедшего в систему.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Output format.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az grafana dashboard import

Импорт панели мониторинга.

Команда CLI заполняет необходимые параметры для источников данных при настройке.

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

Примеры

импортируйте панель мониторинга "AKS Container Insights" из коллекции Grafana.

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

импорт панели мониторинга из файла.

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

Обязательные параметры

--definition

Полная модель панели мониторинга в строке json, идентификатор коллекции Grafana, путь или URL-адрес файла с таким содержимым.

--name -n

Имя Управляемой Grafana в Azure.

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-key --token -t

Ключ API или маркер учетной записи службы, случайно созданная строка, используемая для взаимодействия с конечной точкой Grafana; Если отсутствует, интерфейс командной строки будет использовать учетные данные текущего пользователя, вошедшего в систему.

--folder

Uid или title, которые могут идентифицировать папку. ИНТЕРФЕЙС командной строки сначала будет выполнять поиск по пользовательскому интерфейсу, а затем заголовок, пока он не находит совпадение.

--overwrite

Перезапись панели мониторинга с одинаковым пользовательским интерфейсом.

Свойство Значение
Допустимые значения: false, true
--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Output format.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az grafana dashboard list

Вывод списка всех панелей мониторинга экземпляра.

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

Примеры

Найдите панель мониторинга для сервера API K8s и получите уникальный идентификатор (чтобы вызвать команду az grafana dashboard show)

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

Обязательные параметры

--name -n

Имя Управляемой Grafana в Azure.

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-key --token -t

Ключ API или маркер учетной записи службы, случайно созданная строка, используемая для взаимодействия с конечной точкой Grafana; Если отсутствует, интерфейс командной строки будет использовать учетные данные текущего пользователя, вошедшего в систему.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Output format.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az grafana dashboard show

Получение сведений о панели мониторинга.

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

Примеры

Получение сведений о панели мониторинга, указанной уникальным идентификатором (используйте команду az grafana dashboard list для получения пользовательского интерфейса)

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

Обязательные параметры

--dashboard

Dashboard uid.

--name -n

Имя Управляемой Grafana в Azure.

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-key --token -t

Ключ API или маркер учетной записи службы, случайно созданная строка, используемая для взаимодействия с конечной точкой Grafana; Если отсутствует, интерфейс командной строки будет использовать учетные данные текущего пользователя, вошедшего в систему.

--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Output format.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az grafana dashboard sync

Предварительный просмотр

Эта команда находится в предварительной версии и находится в процессе разработки. Уровни справки и поддержки: https://aka.ms/CLI_refstatus

Синхронизация панелей мониторинга Azure Managed Grafana из одного экземпляра в другой экземпляр. Панели библиотеки на панелях мониторинга будут автоматически включены в синхронизацию. Обратите внимание, что панели мониторинга с состоянием "Подготовлено" будут пропущены из-за того, что они доступны только для чтения.

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

Примеры

Синхронизация только панелей мониторинга в нескольких папках

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"

Синхронизация одной панели мониторинга

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"

Предварительная версия синхронизации

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

Обязательные параметры

--destination -d

Идентификатор ресурса целевой рабочей области.

--source -s

Идентификатор ресурса исходной рабочей области.

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--dashboards-to-exclude

Разделенные пробелами заголовки панелей мониторинга для исключения в синхронизации. Связывание с --folders-to-exclude для определенных папок.

--dashboards-to-include

Разделенные пробелами заголовки панелей мониторинга для включения в синхронизацию. Связывание с папками для определенных папок.

--dry-run

Предварительный просмотр изменений w/o фиксации.

Свойство Значение
Допустимые значения: false, true
--folders-to-exclude -e

Папки для исключения в резервном копировании или синхронизации.

--folders-to-include -i

Папки для включения в резервную копию или синхронизацию.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Output format.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False

az grafana dashboard update

Обновите панель мониторинга.

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

Примеры

Обновите панель мониторинга с определением в json-файле. Для быстрого запуска получите существующую конфигурацию из команды az grafana dashboard show и примените изменения. Поле "версия" необходимо обновить, а поле "перезаписать" должно иметь значение true.

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

Обязательные параметры

--definition

Полная модель панели мониторинга в строке JSON, путь или URL-адрес файла с таким содержимым.

--name -n

Имя Управляемой Grafana в Azure.

Необязательные параметры

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--api-key --token -t

Ключ API или маркер учетной записи службы, случайно созданная строка, используемая для взаимодействия с конечной точкой Grafana; Если отсутствует, интерфейс командной строки будет использовать учетные данные текущего пользователя, вошедшего в систему.

--folder

Uid или title, которые могут идентифицировать папку. ИНТЕРФЕЙС командной строки сначала будет выполнять поиск по пользовательскому интерфейсу, а затем заголовок, пока он не находит совпадение.

--overwrite

Перезапись панели мониторинга с одинаковым пользовательским интерфейсом.

Свойство Значение
Допустимые значения: false, true
--resource-group -g

Имя группы ресурсов. Группу по умолчанию можно настроить с помощью az configure --defaults group=<name>.

Глобальные параметры
--debug

Повышение уровня детализации журнала для включения всех журналов отладки.

Свойство Значение
Default value: False
--help -h

Показать это сообщение справки и выйти.

--only-show-errors

Отображать только ошибки, не показывая предупреждения.

Свойство Значение
Default value: False
--output -o

Output format.

Свойство Значение
Default value: json
Допустимые значения: json, jsonc, none, table, tsv, yaml, yamlc
--query

Строка запроса JMESPath. Дополнительные сведения и примеры см. в разделе http://jmespath.org/.

--subscription

Имя или идентификатор подписки. Подписку по умолчанию можно настроить с помощью az account set -s NAME_OR_ID.

--verbose

Увеличьте уровень детализации ведения журнала. Чтобы включить полные журналы отладки, используйте параметр --debug.

Свойство Значение
Default value: False