你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
az grafana
注意
此参考是 Azure CLI(版本 2.61.0 或更高版本)的 amg 扩展的一部分。 该扩展将在首次运行 az grafana 命令时自动安装。 详细了解扩展。
用于管理 Azure 托管 Grafana 资源的命令。
命令
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
必需参数
Azure 托管 Grafana 的名称。
可选参数
要备份的 Grafana 项目类型。
用于备份 Grafana 项目的目录。
备份或同步中要排除的文件夹。
要包含在备份或同步中的文件夹。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az grafana create
为 Grafana 资源创建工作区。 此 API 是幂等的,因此用户可以创建新的 grafana 或更新现有的 grafana。
az grafana create --name
--resource-group
[--api-key {Disabled, Enabled}]
[--deterministic-outbound-ip {Disabled, Enabled}]
[--grafana-major-version]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--principal-ids]
[--public-network-access {Disabled, Enabled}]
[--skip-identity {0, 1, f, false, n, no, t, true, y, yes}]
[--skip-role-assignments {0, 1, f, false, n, no, t, true, y, yes}]
[--sku-tier]
[--tags]
[--zone-redundancy {Disabled, Enabled}]
示例
创建启用了标准 SKU 和公共网络访问的 Azure 托管 Grafana 资源
az grafana create --resource-group myResourceGroup --workspace-name myWorkspace --sku-tier Standard --public-network-access Enabled
必需参数
Azure 托管 Grafana 的工作区名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
可选参数
Grafana 实例的 API 密钥设置。
Grafana 实例是否使用确定性的出站 IP。
要面向的主要 Grafana 软件版本。
grafana 资源所在的地理位置。
不等待长时间运行的操作完成。
要作为 Grafana 管理员进行的用户、组等空间分隔的 Azure AD 对象 ID。 提供后,CLI 不会将当前登录的用户设为 Grafana Admin Support 速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。
指示通过公共接口启用或禁用流量的状态。
不要启用系统分配的标识。 如果要自行管理标识,请使用此选项。
跳过为 Grafana 实例和当前 CLI 帐户的托管标识创建默认角色分配。 如果要自行管理角色分配,请使用此选项。
grafana 资源的 SKU。
grafana 资源的标记。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。
Grafana 实例的区域冗余设置。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az grafana delete
删除 Grafana 资源的工作区。
az grafana delete [--ids]
[--name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
可选参数
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
Azure 托管 Grafana 的工作区名称。
不等待长时间运行的操作完成。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
不提示确认。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az grafana list
列出指定订阅下 Grafana 工作区的所有资源。
az grafana list [--max-items]
[--next-token]
[--resource-group]
可选参数
命令输出中要返回的项总数。 如果可用的项总数大于指定的值,则会在命令的输出中提供令牌。 若要恢复分页,请在后续命令的参数中 --next-token
提供令牌值。
用于指定开始分页的位置的令牌。 这是先前截断的响应中的令牌值。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az grafana list-available-plugin
列出所有可用的插件。
az grafana list-available-plugin [--ids]
[--name]
[--resource-group]
[--subscription]
可选参数
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
Azure 托管 Grafana 的工作区名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az grafana migrate
此命令处于预览阶段,正在开发中。 参考和支持级别: https://aka.ms/CLI_refstatus
将现有 Grafana 实例迁移到 Azure 托管 Grafana 实例。
az grafana migrate --name
--src-endpoint
--src-token-or-key
[--dry-run {false, true}]
[--folders-to-exclude]
[--folders-to-include]
[--overwrite {false, true}]
[--resource-group]
示例
将仪表板和文件夹从本地 Grafana 实例迁移到 Azure 托管 Grafana 实例。
az grafana migrate -g MyResourceGroup -n MyGrafana -s http://localhost:3000 -t YourServiceTokenOrAPIKey
必需参数
Azure 托管 Grafana 的名称。
要从中迁移的 Grafana 实例终结点。
Grafana 实例服务令牌(或 API 密钥)用于获取从中迁移的访问权限。
可选参数
预览更改而不提交。 优先于 --overwrite。
备份或同步中要排除的文件夹。
要包含在备份或同步中的文件夹。
使用相同 uid 或标题覆盖以前的仪表板、库面板和文件夹。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --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
必需参数
存档以从中还原 Grafana 项目。
Azure 托管 Grafana 的名称。
可选参数
要备份的 Grafana 项目类型。
还原期间,通过名称匹配更新仪表板以引用目标工作区中定义的数据源。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az grafana show
获取 Grafana 资源的特定工作区的属性。
az grafana show [--ids]
[--name]
[--resource-group]
[--subscription]
可选参数
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
Azure 托管 Grafana 的工作区名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az grafana update
更新 Grafana 资源的工作区。
az grafana update [--api-key {Disabled, Enabled}]
[--deterministic-outbound-ip {Disabled, Enabled}]
[--from-address]
[--from-name]
[--grafana-major-version]
[--host]
[--ids]
[--name]
[--password]
[--public-network-access {Disabled, Enabled}]
[--resource-group]
[--skip-verify {0, 1, f, false, n, no, t, true, y, yes}]
[--sku-tier]
[--smtp {0, 1, f, false, n, no, t, true, y, yes}]
[--start-tls-policy {MandatoryStartTLS, NoStartTLS, OpportunisticStartTLS}]
[--subscription]
[--tags]
[--user]
[--zone-redundancy {Disabled, Enabled}]
示例
禁用公用网络访问
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
可选参数
Grafana 实例的 API 密钥设置。
Grafana 实例是否使用确定性的出站 IP。
发送电子邮件 https://pkg.go.dev/net/mail#Address时使用的地址。
发送电子邮件时要使用的名称。 默认值为“Azure 托管 Grafana 通知”。 https://pkg.go.dev/net/mail#Address
要面向的主要 Grafana 软件版本。
具有端口的 SMTP 服务器主机名,例如 test.email.net:587。
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
Azure 托管 Grafana 的工作区名称。
SMTP 身份验证的密码。如果密码包含 # 或 ;,则必须用三引号包装它。
指示通过公共接口启用或禁用流量的状态。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
验证 SMTP 服务器的 SSL。 默认值为 false https://pkg.go.dev/crypto/tls#Config。
grafana 资源的 SKU。
启用此选项以允许 Grafana 发送电子邮件。
SMTP 配置的 https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicyStartTLSPolicy 设置。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
grafana 资源的标记。 支持速记语法、json-file 和 yaml-file。 请尝试“??” 以显示更多内容。
SMTP 身份验证的用户。
Grafana 实例的区域冗余设置。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。
az grafana wait
将 CLI 置于等待状态,直到满足条件。
az grafana wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
可选参数
等待在“Succeeded”中使用“provisioningState”创建。
等待条件满足自定义 JMESPath 查询。 例如 provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running']。
等到删除为止。
等待资源存在。
一个或多个资源 ID(以空格分隔)。 它应该是包含“Resource Id”参数的所有信息的完整资源 ID。 应提供 --ids 或其他“Resource Id”参数。
轮询间隔(以秒为单位)。
Azure 托管 Grafana 的工作区名称。
资源组的名称。 可以使用 az configure --defaults group=<name>
配置默认组。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
最大等待(以秒为单位)。
等到 provisioningState 更新为“Succeeded”。
全局参数
提高日志记录详细程度以显示所有调试日志。
显示此帮助消息并退出。
只显示错误,取消显示警告。
输出格式。
JMESPath 查询字符串。 有关更多信息和示例,请参阅 http://jmespath.org/。
订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID
配置默认订阅。
提高日志记录详细程度。 使用 --debug 获取完整的调试日志。