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

Microsoft.Insights 工作簿 2022-04-01

项目
12/20/2024

Bicep 资源定义

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

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

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

资源格式

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

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

属性值

Microsoft.Insights/workbooks

名字	描述	价值
etag	资源 etag	字符串
身份	用于 BYOS 的标识	WorkbookResourceIdentity
类	工作簿的类型。仅共享有效值。	“shared”
位置	资源所在的地理位置	string （必需）
名字	资源名称	string （必需）
性能	描述 Azure 资源的工作簿的元数据。	WorkbookProperties
标签	资源标记	标记名称和值的字典。请参阅模板中的标记

TrackedResourceTags

名字	描述	价值

UserAssignedIdentities

名字	描述	价值

UserAssignedIdentity

名字	描述	价值

WorkbookProperties

名字	描述	价值
类别	工作簿类别，在创建时由用户定义。	string （必需）
描述	工作簿的说明。	字符串
displayName	工作簿的用户定义名称（显示名称）。	string （必需）
serializedData	此特定工作簿的配置。配置数据是包含有效 JSON 的字符串	string （必需）
sourceId	源资源的 ResourceId。	字符串
storageUri	使用自带存储时的 resourceId 到存储帐户	字符串
标签	已弃用，请使用其他标记字段	string[]
版本	工作簿架构版本格式，如“Notebook/1.0”，它应与 serializedData 中的工作簿匹配	字符串

WorkbookResourceIdentity

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

用法示例

Azure 快速入门示例

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

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

ARM 模板资源定义

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

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

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

资源格式

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

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

属性值

Microsoft.Insights/workbooks

名字	描述	价值
apiVersion	API 版本	'2022-04-01'
etag	资源 etag	字符串
身份	用于 BYOS 的标识	WorkbookResourceIdentity
类	工作簿的类型。仅共享有效值。	“shared”
位置	资源所在的地理位置	string （必需）
名字	资源名称	string （必需）
性能	描述 Azure 资源的工作簿的元数据。	WorkbookProperties
标签	资源标记	标记名称和值的字典。请参阅模板中的标记
类型	资源类型	“Microsoft.Insights/workbooks”

TrackedResourceTags

名字	描述	价值

UserAssignedIdentities

名字	描述	价值

UserAssignedIdentity

名字	描述	价值

WorkbookProperties

名字	描述	价值
类别	工作簿类别，在创建时由用户定义。	string （必需）
描述	工作簿的说明。	字符串
displayName	工作簿的用户定义名称（显示名称）。	string （必需）
serializedData	此特定工作簿的配置。配置数据是包含有效 JSON 的字符串	string （必需）
sourceId	源资源的 ResourceId。	字符串
storageUri	使用自带存储时的 resourceId 到存储帐户	字符串
标签	已弃用，请使用其他标记字段	string[]
版本	工作簿架构版本格式，如“Notebook/1.0”，它应与 serializedData 中的工作簿匹配	字符串

WorkbookResourceIdentity

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

用法示例

Azure 快速入门模板

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

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

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

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

资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/workbooks@2022-04-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    etag = "string"
    kind = "string"
    properties = {
      category = "string"
      description = "string"
      displayName = "string"
      serializedData = "string"
      sourceId = "string"
      storageUri = "string"
      tags = [
        "string"
      ]
      version = "string"
    }
  }
}

属性值

Microsoft.Insights/workbooks

名字	描述	价值
etag	资源 etag	字符串
身份	用于 BYOS 的标识	WorkbookResourceIdentity
类	工作簿的类型。仅共享有效值。	“shared”
位置	资源所在的地理位置	string （必需）
名字	资源名称	string （必需）
性能	描述 Azure 资源的工作簿的元数据。	WorkbookProperties
标签	资源标记	标记名称和值的字典。
类型	资源类型	“Microsoft.Insights/workbooks@2022-04-01”

TrackedResourceTags

名字	描述	价值

UserAssignedIdentities

名字	描述	价值

UserAssignedIdentity

名字	描述	价值

WorkbookProperties

名字	描述	价值
类别	工作簿类别，在创建时由用户定义。	string （必需）
描述	工作簿的说明。	字符串
displayName	工作簿的用户定义名称（显示名称）。	string （必需）
serializedData	此特定工作簿的配置。配置数据是包含有效 JSON 的字符串	string （必需）
sourceId	源资源的 ResourceId。	字符串
storageUri	使用自带存储时的 resourceId 到存储帐户	字符串
标签	已弃用，请使用其他标记字段	string[]
版本	工作簿架构版本格式，如“Notebook/1.0”，它应与 serializedData 中的工作簿匹配	字符串

WorkbookResourceIdentity

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

通过

Microsoft.Insights 工作簿 2022-04-01

Bicep 资源定义

资源格式

属性值

Microsoft.Insights/workbooks

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

WorkbookProperties

WorkbookResourceIdentity

用法示例

Azure 快速入门示例

ARM 模板资源定义

资源格式

属性值

Microsoft.Insights/workbooks

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

WorkbookProperties

WorkbookResourceIdentity

用法示例

Azure 快速入门模板

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

资源格式

属性值

Microsoft.Insights/workbooks

TrackedResourceTags

UserAssignedIdentities

UserAssignedIdentity

WorkbookProperties

WorkbookResourceIdentity

反馈

其他资源