使用英语阅读

通过

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

Microsoft.Insights 工作簿 2020-10-20

  • 项目
选择部署语言

Bicep 资源定义

可以使用目标操作部署工作簿资源类型：

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

资源格式

若要创建 Microsoft.Insights/workbooks 资源，请将以下 Bicep 添加到模板。

Bicep 
resource symbolicname 'Microsoft.Insights/workbooks@2020-10-20' = {
  etag: {
    {customized property}: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    category: 'string'
    displayName: 'string'
    serializedData: 'string'
    sourceId: 'string'
    storageUri: 'string'
    tags: [
      'string'
    ]
    version: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

Microsoft.Insights/workbooks

名字 描述 价值
etag 资源 etag ResourceEtag
身份 用于 BYOS 的标识 WorkbookManagedIdentity
类 工作簿的类型。 选项为用户和共享。 “shared”
“user”
位置 资源位置 字符串
名字 资源名称 string （必需）
性能 描述 Azure 资源的工作簿的元数据。 WorkbookProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记

ResourceEtag

名字 描述 价值

ResourceTags

名字 描述 价值

WorkbookManagedIdentity

名字 描述 价值
类型 标识类型。 “None”
“UserAssigned”
userAssignedIdentities 客户托管标识 WorkbookUserAssignedIdentities

WorkbookProperties

名字 描述 价值
类别 工作簿类别，在创建时由用户定义。 string （必需）
displayName 工作簿的用户定义名称（显示名称）。 string （必需）
serializedData 此特定工作簿的配置。 配置数据是包含有效 JSON 的字符串 string （必需）
sourceId 源资源的 ResourceId。 字符串
storageUri BYOS 存储帐户 URI 字符串
标签 与此工作簿定义关联的 0 个或多个标记的列表 string[]
版本 工作簿版本 字符串

WorkbookUserAssignedIdentities

名字 描述 价值

用法示例

Azure 快速入门示例

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

Bicep 文件 描述
成本优化工作簿 此模板基于 Well-Architected 框架创建新的 Azure Monitor 工作簿，用于成本优化。
FinOps 工具包工作簿 此模板创建一个新的 Azure Monitor 工作簿进行治理。

ARM 模板资源定义

可以使用目标操作部署工作簿资源类型：

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

资源格式

若要创建 Microsoft.Insights/workbooks 资源，请将以下 JSON 添加到模板。

JSON 
{
  "type": "Microsoft.Insights/workbooks",
  "apiVersion": "2020-10-20",
  "name": "string",
  "etag": {
    "{customized property}": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "category": "string",
    "displayName": "string",
    "serializedData": "string",
    "sourceId": "string",
    "storageUri": "string",
    "tags": [ "string" ],
    "version": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

Microsoft.Insights/workbooks

名字 描述 价值
apiVersion API 版本 '2020-10-20'
etag 资源 etag ResourceEtag
身份 用于 BYOS 的标识 WorkbookManagedIdentity
类 工作簿的类型。 选项为用户和共享。 “shared”
“user”
位置 资源位置 字符串
名字 资源名称 string （必需）
性能 描述 Azure 资源的工作簿的元数据。 WorkbookProperties
标签 资源标记 标记名称和值的字典。 请参阅模板 中的 标记
类型 资源类型 “Microsoft.Insights/workbooks”

ResourceEtag

名字 描述 价值

ResourceTags

名字 描述 价值

WorkbookManagedIdentity

名字 描述 价值
类型 标识类型。 “None”
“UserAssigned”
userAssignedIdentities 客户托管标识 WorkbookUserAssignedIdentities

WorkbookProperties

名字 描述 价值
类别 工作簿类别，在创建时由用户定义。 string （必需）
displayName 工作簿的用户定义名称（显示名称）。 string （必需）
serializedData 此特定工作簿的配置。 配置数据是包含有效 JSON 的字符串 string （必需）
sourceId 源资源的 ResourceId。 字符串
storageUri BYOS 存储帐户 URI 字符串
标签 与此工作簿定义关联的 0 个或多个标记的列表 string[]
版本 工作簿版本 字符串

WorkbookUserAssignedIdentities

名字 描述 价值

用法示例

Azure 快速入门模板

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

模板 描述
成本优化工作簿

部署到 Azure 		此模板基于 Well-Architected 框架创建新的 Azure Monitor 工作簿，用于成本优化。
FinOps 工具包工作簿

部署到 Azure 		此模板创建一个新的 Azure Monitor 工作簿进行治理。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署工作簿资源类型：

  • 资源组

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

资源格式

若要创建 Microsoft.Insights/workbooks 资源，请将以下 Terraform 添加到模板中。

Terraform 
resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/workbooks@2020-10-20"
  name = "string"
  etag = {
    {customized property} = "string"
  }
  identity = {
    type = "string"
    userAssignedIdentities = {
    }
  }
  kind = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      category = "string"
      displayName = "string"
      serializedData = "string"
      sourceId = "string"
      storageUri = "string"
      tags = [
        "string"
      ]
      version = "string"
    }
  })
}

属性值

Microsoft.Insights/workbooks

名字 描述 价值
etag 资源 etag ResourceEtag
身份 用于 BYOS 的标识 WorkbookManagedIdentity
类 工作簿的类型。 选项为用户和共享。 “shared”
“user”
位置 资源位置 字符串
名字 资源名称 string （必需）
性能 描述 Azure 资源的工作簿的元数据。 WorkbookProperties
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.Insights/workbooks@2020-10-20”

ResourceEtag

名字 描述 价值

ResourceTags

名字 描述 价值

WorkbookManagedIdentity

名字 描述 价值
类型 标识类型。 “None”
“UserAssigned”
userAssignedIdentities 客户托管标识 WorkbookUserAssignedIdentities

WorkbookProperties

名字 描述 价值
类别 工作簿类别，在创建时由用户定义。 string （必需）
displayName 工作簿的用户定义名称（显示名称）。 string （必需）
serializedData 此特定工作簿的配置。 配置数据是包含有效 JSON 的字符串 string （必需）
sourceId 源资源的 ResourceId。 字符串
storageUri BYOS 存储帐户 URI 字符串
标签 与此工作簿定义关联的 0 个或多个标记的列表 string[]
版本 工作簿版本 字符串

WorkbookUserAssignedIdentities

名字 描述 价值