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

microsoft.insights 工作簿 2015-05-01

• 最近的
• 2023-06-01
• 2022-04-01
• 2021-08-01
• 2021-03-08
• 2020-10-20
• 2015-05-01

Bicep 资源定义

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

• 资源组 - 请参阅 资源组部署命令

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

资源格式

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

resource symbolicname 'microsoft.insights/workbooks@2015-05-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  properties: {
    category: 'string'
    kind: 'string'
    name: 'string'
    serializedData: 'string'
    sourceResourceId: 'string'
    tags: [
      'string'
    ]
    userId: 'string'
    version: 'string'
    workbookId: 'string'
  }
}

属性值

练习 册

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

WorkbookProperties

名字	描述	价值
类别	工作簿类别，在创建时由用户定义。	string （必需）
类	枚举，指示此工作簿定义是否由特定用户拥有，或者是否在有权访问 Application Insights 组件的所有用户之间共享。	“shared” “user”（必需）
名字	工作簿的用户定义名称。	string （必需）
serializedData	此特定工作簿的配置。 配置数据是包含有效 JSON 的字符串	string （必需）
sourceResourceId	源资源的可选 resourceId。	字符串
标签	与此工作簿定义关联的 0 个或多个标记的列表	string[]
userId	拥有此工作簿的特定用户的唯一用户 ID。	string （必需）
版本	此实例的数据模型版本。 这可以在添加可标记为工作簿的新功能时更改。	字符串
workbookId	工作簿定义在内部分配的唯一 ID。	string （必需）

快速入门模板

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

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

ARM 模板资源定义

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

• 资源组 - 请参阅 资源组部署命令

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

资源格式

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

{
  "type": "microsoft.insights/workbooks",
  "apiVersion": "2015-05-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "properties": {
    "category": "string",
    "kind": "string",
    "name": "string",
    "serializedData": "string",
    "sourceResourceId": "string",
    "tags": [ "string" ],
    "userId": "string",
    "version": "string",
    "workbookId": "string"
  }
}

属性值

练习 册

名字	描述	价值
类型	资源类型	“microsoft.insights/workbooks”
apiVersion	资源 API 版本	'2015-05-01'
名字	资源名称	string （必需）
位置	资源位置	字符串
标签	资源标记	标记名称和值的字典。 请参阅模板 中的 标记
类	工作簿的类型。 选项为用户和共享。	“shared” “user”
性能	描述 Azure 资源的 Web 测试的元数据。	WorkbookProperties

WorkbookProperties

名字	描述	价值
类别	工作簿类别，在创建时由用户定义。	string （必需）
类	枚举，指示此工作簿定义是否由特定用户拥有，或者是否在有权访问 Application Insights 组件的所有用户之间共享。	“shared” “user”（必需）
名字	工作簿的用户定义名称。	string （必需）
serializedData	此特定工作簿的配置。 配置数据是包含有效 JSON 的字符串	string （必需）
sourceResourceId	源资源的可选 resourceId。	字符串
标签	与此工作簿定义关联的 0 个或多个标记的列表	string[]
userId	拥有此工作簿的特定用户的唯一用户 ID。	string （必需）
版本	此实例的数据模型版本。 这可以在添加可标记为工作簿的新功能时更改。	字符串
workbookId	工作簿定义在内部分配的唯一 ID。	string （必需）

快速入门模板

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

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

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

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

• 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "microsoft.insights/workbooks@2015-05-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      category = "string"
      kind = "string"
      name = "string"
      serializedData = "string"
      sourceResourceId = "string"
      tags = [
        "string"
      ]
      userId = "string"
      version = "string"
      workbookId = "string"
    }
    kind = "string"
  })
}

属性值

练习 册

名字	描述	价值
类型	资源类型	“microsoft.insights/workbooks@2015-05-01”
名字	资源名称	string （必需）
位置	资源位置	字符串
parent_id	若要部署到资源组，请使用该资源组的 ID。	string （必需）
标签	资源标记	标记名称和值的字典。
类	工作簿的类型。 选项为用户和共享。	“共享” “user”
性能	描述 Azure 资源的 Web 测试的元数据。	WorkbookProperties

WorkbookProperties

名字	描述	价值
类别	工作簿类别，在创建时由用户定义。	string （必需）
类	枚举，指示此工作簿定义是否由特定用户拥有，或者是否在有权访问 Application Insights 组件的所有用户之间共享。	“共享” “user” （必需）
名字	工作簿的用户定义名称。	string （必需）
serializedData	此特定工作簿的配置。 配置数据是包含有效 JSON 的字符串	string （必需）
sourceResourceId	源资源的可选 resourceId。	字符串
标签	与此工作簿定义关联的 0 个或多个标记的列表	string[]
userId	拥有此工作簿的特定用户的唯一用户 ID。	string （必需）
版本	此实例的数据模型版本。 这可以在添加可标记为工作簿的新功能时更改。	字符串
workbookId	工作簿定义在内部分配的唯一 ID。	string （必需）