你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

az grafana

注意

此参考是 Azure CLI(版本 2.38.0 或更高版本)的 amg 扩展的一部分。 该扩展将在首次运行 az grafana 命令时自动安装。 详细了解扩展。

用于管理 Azure Grafana 实例的命令。

为了获得优化体验,并非所有数据平面 API(记录在)上 https://grafana.com/docs/grafana/latest/http_api/都会公开。 有关覆盖差距,请联系 ad4g@microsoft.com。

命令

名称 说明 类型 状态
az grafana api-key

用于管理 API 密钥的命令。

扩展 GA
az grafana api-key create

创建新的 API 密钥。

扩展 GA
az grafana api-key delete

删除 API 密钥。

扩展 GA
az grafana api-key list

列出现有 API 密钥。

扩展 GA
az grafana backup

将 Azure 托管 Grafana 实例的内容备份到存档。

扩展 预览
az grafana create

创建 Azure 托管 Grafana 实例。

扩展 GA
az grafana dashboard

用于管理实例仪表板的命令。

扩展 GA
az grafana dashboard create

创建新的仪表板。

扩展 GA
az grafana dashboard delete

删除仪表板。

扩展 GA
az grafana dashboard import

导入仪表板。

扩展 GA
az grafana dashboard list

列出实例的所有仪表板。

扩展 GA
az grafana dashboard show

获取仪表板的详细信息。

扩展 GA
az grafana dashboard sync

将 Azure 托管 Grafana 仪表板从一个实例同步到另一个实例。 请注意,由于只读,将跳过具有“已预配”状态的仪表板。

扩展 预览
az grafana dashboard update

更新仪表板。

扩展 GA
az grafana data-source

用于管理实例数据源的命令。

扩展 GA
az grafana data-source create

创建数据源。

扩展 GA
az grafana data-source delete

删除数据源。

扩展 GA
az grafana data-source list

列出实例的所有数据源。

扩展 GA
az grafana data-source query

查询具有后端实现的数据源。

扩展 GA
az grafana data-source show

获取数据源的详细信息。

扩展 GA
az grafana data-source update

更新数据源。

扩展 GA
az grafana delete

删除 Azure 托管 Grafana 实例。

扩展 GA
az grafana folder

用于管理实例文件夹的命令。

扩展 GA
az grafana folder create

新建文件夹。

扩展 GA
az grafana folder delete

删除文件夹。

扩展 GA
az grafana folder list

列出实例的所有文件夹。

扩展 GA
az grafana folder show

获取文件夹的详细信息。

扩展 GA
az grafana folder update

更新文件夹。

扩展 GA
az grafana list

列出 Azure 托管 Grafana 实例。

扩展 GA
az grafana notification-channel

用于管理实例通知通道的命令。

扩展 GA
az grafana notification-channel create

创建通知通道。

扩展 GA
az grafana notification-channel delete

删除通知通道。

扩展 GA
az grafana notification-channel list

列出实例的所有通知通道。

扩展 GA
az grafana notification-channel show

获取通知通道的详细信息。

扩展 GA
az grafana notification-channel test

测试通知通道。

扩展 GA
az grafana notification-channel update

更新通知通道。

扩展 GA
az grafana restore

从存档还原 Azure 托管 Grafana 实例。

扩展 预览
az grafana service-account

用于管理服务帐户的命令。

扩展 GA
az grafana service-account create

创建新的服务帐户。

扩展 GA
az grafana service-account delete

删除服务帐户。

扩展 GA
az grafana service-account list

列出现有服务帐户。

扩展 GA
az grafana service-account show

获取服务帐户的详细信息。

扩展 GA
az grafana service-account token

用于管理服务帐户令牌的命令。

扩展 GA
az grafana service-account token create

创建新的服务帐户令牌。

扩展 GA
az grafana service-account token delete

删除服务帐户令牌。

扩展 GA
az grafana service-account token list

列出现有服务帐户令牌。

扩展 GA
az grafana service-account update

更新服务帐户。

扩展 GA
az grafana show

显示 Azure 托管 Grafana 实例的详细信息。

扩展 GA
az grafana update

更新 Azure 托管 Grafana 实例。

扩展 GA
az grafana user

用于管理实例用户的命令。

扩展 GA
az grafana user actual-user

获取当前用户的详细信息。

扩展 GA
az grafana user list

列出用户。

扩展 GA
az grafana user show

获取用户的详细信息。

扩展 GA

az grafana backup

预览

此命令处于预览阶段,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

将 Azure 托管 Grafana 实例的内容备份到存档。

az grafana backup --name
                  [--components {annotations, dashboards, datasources, folders, snapshots}]
                  [--directory]
                  [--folders-to-exclude]
                  [--folders-to-include]
                  [--resource-group]

示例

备份仪表板 2 个文件夹下(数据源包含在内,以便在将仪表板还原到另一个工作区时启用名称重新映射)

az grafana backup -g MyResourceGroup -n MyGrafana -d c:\temp --folders-to-include "Prod" "Compute Gateway" --components datasources dashboards folders

备份仪表板并跳过几个文件夹

az grafana backup -g MyResourceGroup -n MyGrafana -d c:\temp  --folders-to-exclude General "Azure Monitor" --components datasources dashboards folders

必需参数

--name -n

Azure 托管 Grafana 的名称。

可选参数

--components -c

要备份的 Grafana 项目类型。

接受的值: annotations, dashboards, datasources, folders, snapshots
--directory -d

用于备份 Grafana 项目的目录。

--folders-to-exclude -e

备份或同步中要排除的文件夹。

--folders-to-include -i

要包含在备份或同步中的文件夹。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az grafana create

创建 Azure 托管 Grafana 实例。

az grafana create --name
                  --resource-group
                  [--deterministic-outbound-ip {Disabled, Enabled}]
                  [--location]
                  [--principal-ids]
                  [--principal-types {Group, ServicePrincipal, User}]
                  [--skip-role-assignments {false, true}]
                  [--skip-system-assigned-identity {false, true}]
                  [--tags]
                  [--zone-redundancy {Disabled, Enabled}]

必需参数

--name -n

Azure 托管 Grafana 的名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--deterministic-outbound-ip -i

如果启用,Grafana 工作区将具有固定的出口 IP,可以在数据源的防火墙中使用它们。 默认:已禁用。

接受的值: Disabled, Enabled
--location -l

Location。 az account list-locations 中的值。 可以使用 az configure --defaults location=<location> 配置默认位置。

--principal-ids

要作为 Grafana 管理员 进行的用户、组等空间分隔的 Azure AD 对象 ID。 提供后,CLI 不会将当前登录的用户设为 Grafana 管理员。

--principal-types

要与 --principal-id 配对的空间分隔 Azure AD 主体类型。

接受的值: Group, ServicePrincipal, User
--skip-role-assignments

不要为托管标识和当前登录用户创建角色分配。

接受的值: false, true
默认值: False
--skip-system-assigned-identity -s

不要启用系统分配的标识。

接受的值: false, true
默认值: False
--tags

空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。

--zone-redundancy

指示是否应启用区域冗余。 默认:已禁用。

接受的值: Disabled, Enabled
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az grafana delete

删除 Azure 托管 Grafana 实例。

az grafana delete --name
                  [--resource-group]
                  [--yes]

必需参数

--name -n

Azure 托管 Grafana 的名称。

可选参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--yes -y

不提示确认。

默认值: False
全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az grafana list

列出 Azure 托管 Grafana 实例。

az grafana list [--resource-group]

可选参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az grafana restore

预览

此命令处于预览阶段,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus

从存档还原 Azure 托管 Grafana 实例。

az grafana restore --archive-file
                   --name
                   [--components {annotations, dashboards, datasources, folders, snapshots}]
                   [--remap-data-sources {false, true}]
                   [--resource-group]

示例

还原仪表板。 如果它们位于文件夹下,请在组件列表中包括“文件夹”;使用“--remap-data-sources”,因此 CLI 会将仪表板更新为指向目标工作区中的相同数据源

az grafana restore -g MyResourceGroup -n MyGrafana --archive-file backup\dashboards\ServiceHealth-202307051036.tar.gz --components dashboards folders --remap-data-sources

必需参数

--archive-file -a

存档以从中还原 Grafana 项目。

--name -n

Azure 托管 Grafana 的名称。

可选参数

--components -c

要备份的 Grafana 项目类型。

接受的值: annotations, dashboards, datasources, folders, snapshots
--remap-data-sources -r

还原期间,通过名称匹配更新仪表板以引用目标工作区中定义的数据源。

接受的值: false, true
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az grafana show

显示 Azure 托管 Grafana 实例的详细信息。

az grafana show --name
                [--resource-group]

必需参数

--name -n

Azure 托管 Grafana 的名称。

可选参数

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az grafana update

更新 Azure 托管 Grafana 实例。

az grafana update --name
                  [--api-key {Disabled, Enabled}]
                  [--deterministic-outbound-ip {Disabled, Enabled}]
                  [--from-address]
                  [--from-name]
                  [--host]
                  [--major-version]
                  [--password]
                  [--public-network-access {Disabled, Enabled}]
                  [--resource-group]
                  [--skip-verify {false, true}]
                  [--smtp {Disabled, Enabled}]
                  [--start-tls-policy {MandatoryStartTLS, NoStartTLS, OpportunisticStartTLS}]
                  [--tags]
                  [--user]

示例

禁用公用网络访问

az grafana update -g MyResourceGroup -n MyGrafana --public-network-access disabled

通过 mailgun 的 SMTP 中继支持启用邮件通知

az grafana update -g MyResourceGroup -n MyGrafana --smtp enabled --from-address johndoe@outlook.com --from-name john --host "smtp.mailgun.org:587" --user "postmaster@sandbox12345.mailgun.org" --password "password" --start-tls-policy OpportunisticStartTLS --skip-verify true

必需参数

--name -n

Azure 托管 Grafana 的名称。

可选参数

--api-key --service-account

如果启用,你将能够配置 Grafana API 密钥和服务帐户。

接受的值: Disabled, Enabled
--deterministic-outbound-ip -i

如果启用,Grafana 工作区将具有固定的出口 IP,可以在数据源的防火墙中使用它们。

接受的值: Disabled, Enabled
--from-address

发送电子邮件时使用的地址。

--from-name

发送电子邮件时要使用的名称。

--host

SMTP 服务器 URL(包括端口)。

--major-version

Grafana 主版本号。

--password

SMTP 服务器用户密码。

--public-network-access -p

允许公用网络访问。

接受的值: Disabled, Enabled
--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

--skip-verify

跳过验证 SMTP 服务器的 SSL。

接受的值: false, true
--smtp

允许 Grafana 发送电子邮件。

接受的值: Disabled, Enabled
--start-tls-policy

TLS 策略。

接受的值: MandatoryStartTLS, NoStartTLS, OpportunisticStartTLS
--tags

空格分隔标记:key[=value] [key[=value] ...]。使用“”清除现有标记。

--user

SMTP 服务器用户名。

全局参数
--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误,取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc
默认值: json
--query

JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。