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

Microsoft.Dashboard 下载 2024-11-01-preview

Bicep 资源定义

可以使用目标操作部署 grafana 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Dashboard/grafana 资源,请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Dashboard/grafana@2024-11-01-preview' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    apiKey: 'string'
    autoGeneratedDomainNameLabelScope: 'string'
    deterministicOutboundIP: 'string'
    enterpriseConfigurations: {
      marketplaceAutoRenew: 'string'
      marketplacePlanId: 'string'
    }
    grafanaConfigurations: {
      security: {
        csrfAlwaysCheck: bool
      }
      smtp: {
        enabled: bool
        fromAddress: 'string'
        fromName: 'string'
        host: 'string'
        password: 'string'
        skipVerify: bool
        startTLSPolicy: 'string'
        user: 'string'
      }
      snapshots: {
        externalEnabled: bool
      }
      unifiedAlertingScreenshots: {
        captureEnabled: bool
      }
      users: {
        editorsCanAdmin: bool
        viewersCanEdit: bool
      }
    }
    grafanaIntegrations: {
      azureMonitorWorkspaceIntegrations: [
        {
          azureMonitorWorkspaceResourceId: 'string'
        }
      ]
    }
    grafanaMajorVersion: 'string'
    grafanaPlugins: {
      {customized property}: {}
    }
    publicNetworkAccess: 'string'
    zoneRedundancy: 'string'
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

Microsoft.Dashboard/grafana

名称 DESCRIPTION 价值
标识 分配给此资源的托管服务标识。 ManagedServiceIdentity
位置 资源所在的地理位置 string (必需)
姓名 资源名称 字符串

约束:
模式 = ^[a-zA-Z][a-z0-9A-Z-]{0,28}[a-z0-9A-Z]$ (必需)
属性 特定于 grafana 资源的属性。 ManagedGrafana属性
SKU grafana 资源的 SKU。 资源Sku
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

AzureMonitorWorkspace集成

名称 DESCRIPTION 价值
azureMonitorWorkspaceResourceId 连接的 Azure Monitor 工作区的资源 ID。 字符串

EnterpriseConfigurations (企业配置)

名称 DESCRIPTION 价值
marketplaceAutoRenew 企业订阅的 AutoRenew 设置 “Disabled”
“Enabled”
marketplacePlanId 企业插件的 Azure 市场订阅的计划 ID 字符串

Grafana配置

名称 DESCRIPTION 价值
安全 Grafana 安全设置 安全性
SMTP (SMTP) 电子邮件服务器设置。
https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp
SMTP
快照 Grafana 快照设置 快照
unifiedAlerting屏幕截图 Grafana Unified Alerting 屏幕截图设置 UnifiedAlerting屏幕截图
用户 Grafana 用户设置 用户

Grafana集成

名称 DESCRIPTION 价值
azureMonitorWorkspace集成 AzureMonitorWorkspaceIntegration[]

Grafana插件

名称 DESCRIPTION 价值

ManagedGrafana属性

名称 DESCRIPTION 价值
apiKey Grafana 实例的 API 密钥设置。 “Disabled”
“Enabled”
autoGeneratedDomainNameLabelScope dns 确定性名称哈希计算的范围。 “TenantReuse”
deterministicOutboundIP Grafana 实例是否使用确定性的出站 IP。 “Disabled”
“Enabled”
enterpriseConfigurations Grafana 实例的企业设置 EnterpriseConfigurations (企业配置)
grafana配置 Grafana 实例的服务器配置 Grafana配置
grafana集成 GrafanaIntegrations 是捆绑的可观测性体验(例如预先配置的数据源、定制的 Grafana 仪表板、警报默认值),适用于常见监视方案。 Grafana集成
grafanaMajorVersion 要面向的主要 Grafana 软件版本。 字符串
grafana插件 Grafana 实例的已安装插件列表。 键为插件 ID,值为插件定义。 ManagedGrafana属性Grafana插件
公用网络访问 指示通过公共接口启用或禁用流量的状态。 “Disabled”
“Enabled”
区域冗余 Grafana 实例的区域冗余设置。 “Disabled”
“Enabled”

ManagedGrafana属性Grafana插件

名称 DESCRIPTION 价值

ManagedServiceIdentity

名称 DESCRIPTION 价值
类型 托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。 “None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”(必需)
用户分配的标识 与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID,格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象({})。 UserAssignedIdentities

资源Sku

名称 DESCRIPTION 价值
姓名 SKU 的名称。 string (必需)

安全性

名称 DESCRIPTION 价值
csrfAlwaysCheck 设置为 true 以执行 CSRF 检查,即使登录 Cookie 不在请求中(默认值 false)。 布尔

SMTP

名称 DESCRIPTION 价值
启用 启用此选项以允许 Grafana 发送电子邮件。 默认值为 false 布尔
fromAddress 发送电子邮件时使用的地址
https://pkg.go.dev/net/mail#Address
字符串
fromName (发件人名称) 发送电子邮件时要使用的名称。 默认值为“Azure 托管 Grafana 通知”
https://pkg.go.dev/net/mail#Address
字符串
主持人 具有端口的 SMTP 服务器主机名,例如 test.email.net:587 字符串
密码 SMTP 身份验证的密码。如果密码包含 # 或 ;,则必须用三引号包装它 字符串

约束:
敏感值。 以安全参数的形式传入。
skipVerify 验证 SMTP 服务器的 SSL。 默认值为 false
https://pkg.go.dev/crypto/tls#Config
布尔
startTLSPolicy SMTP 配置的 StartTLSPolicy 设置
https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy
“MandatoryStartTLS”
“NoStartTLS”
“OpportunisticStartTLS”
用户 SMTP 身份验证的用户 字符串

快照

名称 DESCRIPTION 价值
外部已启用 设置为 false 以禁用外部快照发布终结点 布尔

TrackedResourceTags

名称 DESCRIPTION 价值

UnifiedAlerting屏幕截图

名称 DESCRIPTION 价值
capture已启用 设置为 false 可由于性能问题而禁用 Unified Alert 中的捕获屏幕截图。 布尔

UserAssignedIdentities

名称 DESCRIPTION 价值

UserAssignedIdentity

名称 DESCRIPTION 价值

用户

名称 DESCRIPTION 价值
editorsCanAdmin 设置为 true,以便编辑者可以管理他们创建的仪表板、文件夹和团队。 布尔
viewerCanEdit 设置为 true,以便查看者可以访问和使用浏览并在他们有权访问的仪表板中的面板上执行临时编辑。 他们无法保存更改。 布尔

用法示例

Azure 快速入门示例

以下 Azure 快速入门模板 包含用于部署此资源类型的 Bicep 示例。

Bicep 文件 DESCRIPTION
使用 Prometheus 和 Grafana 和 privae 链接创建 AKS 这将在 Azure Kubernetes 服务(AKS)群集上创建 Azure grafana、AKS 并安装 Prometheus(开源监视和警报工具包)。 然后使用 Azure Managed Grafana 的托管专用终结点连接到此 Prometheus 服务器并在 Grafana 仪表板中显示 Prometheus 数据

ARM 模板资源定义

可以使用目标操作部署 grafana 资源类型:

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Dashboard/grafana 资源,请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Dashboard/grafana",
  "apiVersion": "2024-11-01-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "apiKey": "string",
    "autoGeneratedDomainNameLabelScope": "string",
    "deterministicOutboundIP": "string",
    "enterpriseConfigurations": {
      "marketplaceAutoRenew": "string",
      "marketplacePlanId": "string"
    },
    "grafanaConfigurations": {
      "security": {
        "csrfAlwaysCheck": "bool"
      },
      "smtp": {
        "enabled": "bool",
        "fromAddress": "string",
        "fromName": "string",
        "host": "string",
        "password": "string",
        "skipVerify": "bool",
        "startTLSPolicy": "string",
        "user": "string"
      },
      "snapshots": {
        "externalEnabled": "bool"
      },
      "unifiedAlertingScreenshots": {
        "captureEnabled": "bool"
      },
      "users": {
        "editorsCanAdmin": "bool",
        "viewersCanEdit": "bool"
      }
    },
    "grafanaIntegrations": {
      "azureMonitorWorkspaceIntegrations": [
        {
          "azureMonitorWorkspaceResourceId": "string"
        }
      ]
    },
    "grafanaMajorVersion": "string",
    "grafanaPlugins": {
      "{customized property}": {
      }
    },
    "publicNetworkAccess": "string",
    "zoneRedundancy": "string"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

Microsoft.Dashboard/grafana

名称 DESCRIPTION 价值
apiVersion API 版本 “2024-11-01-预览”
标识 分配给此资源的托管服务标识。 ManagedServiceIdentity
位置 资源所在的地理位置 string (必需)
姓名 资源名称 字符串

约束:
模式 = ^[a-zA-Z][a-z0-9A-Z-]{0,28}[a-z0-9A-Z]$ (必需)
属性 特定于 grafana 资源的属性。 ManagedGrafana属性
SKU grafana 资源的 SKU。 资源Sku
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.Dashboard/grafana”

AzureMonitorWorkspace集成

名称 DESCRIPTION 价值
azureMonitorWorkspaceResourceId 连接的 Azure Monitor 工作区的资源 ID。 字符串

EnterpriseConfigurations (企业配置)

名称 DESCRIPTION 价值
marketplaceAutoRenew 企业订阅的 AutoRenew 设置 “Disabled”
“Enabled”
marketplacePlanId 企业插件的 Azure 市场订阅的计划 ID 字符串

Grafana配置

名称 DESCRIPTION 价值
安全 Grafana 安全设置 安全性
SMTP (SMTP) 电子邮件服务器设置。
https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp
SMTP
快照 Grafana 快照设置 快照
unifiedAlerting屏幕截图 Grafana Unified Alerting 屏幕截图设置 UnifiedAlerting屏幕截图
用户 Grafana 用户设置 用户

Grafana集成

名称 DESCRIPTION 价值
azureMonitorWorkspace集成 AzureMonitorWorkspaceIntegration[]

Grafana插件

名称 DESCRIPTION 价值

ManagedGrafana属性

名称 DESCRIPTION 价值
apiKey Grafana 实例的 API 密钥设置。 “Disabled”
“Enabled”
autoGeneratedDomainNameLabelScope dns 确定性名称哈希计算的范围。 “TenantReuse”
deterministicOutboundIP Grafana 实例是否使用确定性的出站 IP。 “Disabled”
“Enabled”
enterpriseConfigurations Grafana 实例的企业设置 EnterpriseConfigurations (企业配置)
grafana配置 Grafana 实例的服务器配置 Grafana配置
grafana集成 GrafanaIntegrations 是捆绑的可观测性体验(例如预先配置的数据源、定制的 Grafana 仪表板、警报默认值),适用于常见监视方案。 Grafana集成
grafanaMajorVersion 要面向的主要 Grafana 软件版本。 字符串
grafana插件 Grafana 实例的已安装插件列表。 键为插件 ID,值为插件定义。 ManagedGrafana属性Grafana插件
公用网络访问 指示通过公共接口启用或禁用流量的状态。 “Disabled”
“Enabled”
区域冗余 Grafana 实例的区域冗余设置。 “Disabled”
“Enabled”

ManagedGrafana属性Grafana插件

名称 DESCRIPTION 价值

ManagedServiceIdentity

名称 DESCRIPTION 价值
类型 托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。 “None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”(必需)
用户分配的标识 与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID,格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象({})。 UserAssignedIdentities

资源Sku

名称 DESCRIPTION 价值
姓名 SKU 的名称。 string (必需)

安全性

名称 DESCRIPTION 价值
csrfAlwaysCheck 设置为 true 以执行 CSRF 检查,即使登录 Cookie 不在请求中(默认值 false)。 布尔

SMTP

名称 DESCRIPTION 价值
启用 启用此选项以允许 Grafana 发送电子邮件。 默认值为 false 布尔
fromAddress 发送电子邮件时使用的地址
https://pkg.go.dev/net/mail#Address
字符串
fromName (发件人名称) 发送电子邮件时要使用的名称。 默认值为“Azure 托管 Grafana 通知”
https://pkg.go.dev/net/mail#Address
字符串
主持人 具有端口的 SMTP 服务器主机名,例如 test.email.net:587 字符串
密码 SMTP 身份验证的密码。如果密码包含 # 或 ;,则必须用三引号包装它 字符串

约束:
敏感值。 以安全参数的形式传入。
skipVerify 验证 SMTP 服务器的 SSL。 默认值为 false
https://pkg.go.dev/crypto/tls#Config
布尔
startTLSPolicy SMTP 配置的 StartTLSPolicy 设置
https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy
“MandatoryStartTLS”
“NoStartTLS”
“OpportunisticStartTLS”
用户 SMTP 身份验证的用户 字符串

快照

名称 DESCRIPTION 价值
外部已启用 设置为 false 以禁用外部快照发布终结点 布尔

TrackedResourceTags

名称 DESCRIPTION 价值

UnifiedAlerting屏幕截图

名称 DESCRIPTION 价值
capture已启用 设置为 false 可由于性能问题而禁用 Unified Alert 中的捕获屏幕截图。 布尔

UserAssignedIdentities

名称 DESCRIPTION 价值

UserAssignedIdentity

名称 DESCRIPTION 价值

用户

名称 DESCRIPTION 价值
editorsCanAdmin 设置为 true,以便编辑者可以管理他们创建的仪表板、文件夹和团队。 布尔
viewerCanEdit 设置为 true,以便查看者可以访问和使用浏览并在他们有权访问的仪表板中的面板上执行临时编辑。 他们无法保存更改。 布尔

用法示例

Azure 快速入门模板

以下 Azure 快速入门模板 部署此资源类型。

模板 DESCRIPTION
使用 Prometheus 和 Grafana 和 privae 链接创建 AKS

部署到 Azure
这将在 Azure Kubernetes 服务(AKS)群集上创建 Azure grafana、AKS 并安装 Prometheus(开源监视和警报工具包)。 然后使用 Azure Managed Grafana 的托管专用终结点连接到此 Prometheus 服务器并在 Grafana 仪表板中显示 Prometheus 数据

Terraform (AzAPI 提供程序)资源定义

可以使用目标操作部署 grafana 资源类型:

  • 资源组

有关每个 API 版本中已更改属性的列表,请参阅 更改日志

资源格式

若要创建 Microsoft.Dashboard/grafana 资源,请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Dashboard/grafana@2024-11-01-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      apiKey = "string"
      autoGeneratedDomainNameLabelScope = "string"
      deterministicOutboundIP = "string"
      enterpriseConfigurations = {
        marketplaceAutoRenew = "string"
        marketplacePlanId = "string"
      }
      grafanaConfigurations = {
        security = {
          csrfAlwaysCheck = bool
        }
        smtp = {
          enabled = bool
          fromAddress = "string"
          fromName = "string"
          host = "string"
          password = "string"
          skipVerify = bool
          startTLSPolicy = "string"
          user = "string"
        }
        snapshots = {
          externalEnabled = bool
        }
        unifiedAlertingScreenshots = {
          captureEnabled = bool
        }
        users = {
          editorsCanAdmin = bool
          viewersCanEdit = bool
        }
      }
      grafanaIntegrations = {
        azureMonitorWorkspaceIntegrations = [
          {
            azureMonitorWorkspaceResourceId = "string"
          }
        ]
      }
      grafanaMajorVersion = "string"
      grafanaPlugins = {
        {customized property} = {
        }
      }
      publicNetworkAccess = "string"
      zoneRedundancy = "string"
    }
    sku = {
      name = "string"
    }
  }
}

属性值

Microsoft.Dashboard/grafana

名称 DESCRIPTION 价值
标识 分配给此资源的托管服务标识。 ManagedServiceIdentity
位置 资源所在的地理位置 string (必需)
姓名 资源名称 字符串

约束:
模式 = ^[a-zA-Z][a-z0-9A-Z-]{0,28}[a-z0-9A-Z]$ (必需)
属性 特定于 grafana 资源的属性。 ManagedGrafana属性
SKU grafana 资源的 SKU。 资源Sku
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.Dashboard/grafana@2024-11-01-preview”

AzureMonitorWorkspace集成

名称 DESCRIPTION 价值
azureMonitorWorkspaceResourceId 连接的 Azure Monitor 工作区的资源 ID。 字符串

EnterpriseConfigurations (企业配置)

名称 DESCRIPTION 价值
marketplaceAutoRenew 企业订阅的 AutoRenew 设置 “Disabled”
“Enabled”
marketplacePlanId 企业插件的 Azure 市场订阅的计划 ID 字符串

Grafana配置

名称 DESCRIPTION 价值
安全 Grafana 安全设置 安全性
SMTP (SMTP) 电子邮件服务器设置。
https://grafana.com/docs/grafana/v9.0/setup-grafana/configure-grafana/#smtp
SMTP
快照 Grafana 快照设置 快照
unifiedAlerting屏幕截图 Grafana Unified Alerting 屏幕截图设置 UnifiedAlerting屏幕截图
用户 Grafana 用户设置 用户

Grafana集成

名称 DESCRIPTION 价值
azureMonitorWorkspace集成 AzureMonitorWorkspaceIntegration[]

Grafana插件

名称 DESCRIPTION 价值

ManagedGrafana属性

名称 DESCRIPTION 价值
apiKey Grafana 实例的 API 密钥设置。 “Disabled”
“Enabled”
autoGeneratedDomainNameLabelScope dns 确定性名称哈希计算的范围。 “TenantReuse”
deterministicOutboundIP Grafana 实例是否使用确定性的出站 IP。 “Disabled”
“Enabled”
enterpriseConfigurations Grafana 实例的企业设置 EnterpriseConfigurations (企业配置)
grafana配置 Grafana 实例的服务器配置 Grafana配置
grafana集成 GrafanaIntegrations 是捆绑的可观测性体验(例如预先配置的数据源、定制的 Grafana 仪表板、警报默认值),适用于常见监视方案。 Grafana集成
grafanaMajorVersion 要面向的主要 Grafana 软件版本。 字符串
grafana插件 Grafana 实例的已安装插件列表。 键为插件 ID,值为插件定义。 ManagedGrafana属性Grafana插件
公用网络访问 指示通过公共接口启用或禁用流量的状态。 “Disabled”
“Enabled”
区域冗余 Grafana 实例的区域冗余设置。 “Disabled”
“Enabled”

ManagedGrafana属性Grafana插件

名称 DESCRIPTION 价值

ManagedServiceIdentity

名称 DESCRIPTION 价值
类型 托管服务标识的类型(其中允许 SystemAssigned 和 UserAssigned 类型)。 “None”
“SystemAssigned”
“SystemAssigned,UserAssigned”
“UserAssigned”(必需)
用户分配的标识 与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID,格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象({})。 UserAssignedIdentities

资源Sku

名称 DESCRIPTION 价值
姓名 SKU 的名称。 string (必需)

安全性

名称 DESCRIPTION 价值
csrfAlwaysCheck 设置为 true 以执行 CSRF 检查,即使登录 Cookie 不在请求中(默认值 false)。 布尔

SMTP

名称 DESCRIPTION 价值
启用 启用此选项以允许 Grafana 发送电子邮件。 默认值为 false 布尔
fromAddress 发送电子邮件时使用的地址
https://pkg.go.dev/net/mail#Address
字符串
fromName (发件人名称) 发送电子邮件时要使用的名称。 默认值为“Azure 托管 Grafana 通知”
https://pkg.go.dev/net/mail#Address
字符串
主持人 具有端口的 SMTP 服务器主机名,例如 test.email.net:587 字符串
密码 SMTP 身份验证的密码。如果密码包含 # 或 ;,则必须用三引号包装它 字符串

约束:
敏感值。 以安全参数的形式传入。
skipVerify 验证 SMTP 服务器的 SSL。 默认值为 false
https://pkg.go.dev/crypto/tls#Config
布尔
startTLSPolicy SMTP 配置的 StartTLSPolicy 设置
https://pkg.go.dev/github.com/go-mail/mail#StartTLSPolicy
“MandatoryStartTLS”
“NoStartTLS”
“OpportunisticStartTLS”
用户 SMTP 身份验证的用户 字符串

快照

名称 DESCRIPTION 价值
外部已启用 设置为 false 以禁用外部快照发布终结点 布尔

TrackedResourceTags

名称 DESCRIPTION 价值

UnifiedAlerting屏幕截图

名称 DESCRIPTION 价值
capture已启用 设置为 false 可由于性能问题而禁用 Unified Alert 中的捕获屏幕截图。 布尔

UserAssignedIdentities

名称 DESCRIPTION 价值

UserAssignedIdentity

名称 DESCRIPTION 价值

用户

名称 DESCRIPTION 价值
editorsCanAdmin 设置为 true,以便编辑者可以管理他们创建的仪表板、文件夹和团队。 布尔
viewerCanEdit 设置为 true,以便查看者可以访问和使用浏览并在他们有权访问的仪表板中的面板上执行临时编辑。 他们无法保存更改。 布尔