Microsoft.Insights 活頁簿

  • 發行項

Bicep 資源定義

活頁簿資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Insights/workbooks 資源，請將下列 Bicep 新增至您的範本。

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

屬性值

練習冊

名字 描述 價值
名字 資源名稱 字串 （必要）
位置 資源所在的地理位置 字串 （必要）
標籤 資源標籤。 標記名稱和值的字典。 請參閱範本中的 標籤
類 活頁簿的種類。 只有有效的值是共用的。 'shared'
etag 資源 etag 字串
身份 用於 BYOS 的身分識別 WorkbookResourceIdentity
性能 描述 Azure 資源的活頁簿的元數據。 WorkbookProperties

WorkbookResourceIdentity

名字 描述 價值
類型 受控服務識別的類型（允許 SystemAssigned 和 UserAssigned 類型）。 'None'
'SystemAssigned'
'SystemAssigned，UserAssigned'
'UserAssigned' （必要）
userAssignedIdentities 與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是要求中的空白物件（{}）。 UserAssignedIdentities

UserAssignedIdentities

名字 描述 價值
{自定義屬性} UserAssignedIdentity

UserAssignedIdentity

此物件不包含在部署期間設定的任何屬性。 所有屬性都是 ReadOnly。

WorkbookProperties

名字 描述 價值
類別 活頁簿類別，如使用者在建立時所定義。 字串 （必要）
描述 活頁簿的描述。 字串
displayName 活頁簿的使用者定義名稱（顯示名稱）。 字串 （必要）
serializedData 此特定活頁簿的設定。 設定數據是包含有效 JSON 的字串 字串 （必要）
sourceId 來源資源的 ResourceId。 字串
storageUri 使用您自己的記憶體時，將 resourceId 複製到記憶體帳戶 字串
標籤 已被取代，請使用其他標籤欄位 string[]
版本 活頁簿架構版本格式，例如 『Notebook/1.0』，這應該符合 serializedData 中的活頁簿 字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
FinOps 工具組活頁簿

部署至 Azure 		此範本會建立新的 Azure 監視器活頁簿以進行治理。

ARM 樣本資源定義

活頁簿資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Insights/workbooks 資源，請將下列 JSON 新增至範本。

{
  "type": "Microsoft.Insights/workbooks",
  "apiVersion": "2023-06-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "shared",
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "category": "string",
    "description": "string",
    "displayName": "string",
    "serializedData": "string",
    "sourceId": "string",
    "storageUri": "string",
    "tags": [ "string" ],
    "version": "string"
  }
}

屬性值

練習冊

名字 描述 價值
類型 資源類型 'Microsoft.Insights/workbooks'
apiVersion 資源 API 版本 '2023-06-01'
名字 資源名稱 字串 （必要）
位置 資源所在的地理位置 字串 （必要）
標籤 資源標籤。 標記名稱和值的字典。 請參閱範本中的 標籤
類 活頁簿的種類。 只有有效的值是共用的。 'shared'
etag 資源 etag 字串
身份 用於 BYOS 的身分識別 WorkbookResourceIdentity
性能 描述 Azure 資源的活頁簿的元數據。 WorkbookProperties

WorkbookResourceIdentity

名字 描述 價值
類型 受控服務識別的類型（允許 SystemAssigned 和 UserAssigned 類型）。 'None'
'SystemAssigned'
'SystemAssigned，UserAssigned'
'UserAssigned' （必要）
userAssignedIdentities 與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是要求中的空白物件（{}）。 UserAssignedIdentities

UserAssignedIdentities

名字 描述 價值
{自定義屬性} UserAssignedIdentity

UserAssignedIdentity

此物件不包含在部署期間設定的任何屬性。 所有屬性都是 ReadOnly。

WorkbookProperties

名字 描述 價值
類別 活頁簿類別，如使用者在建立時所定義。 字串 （必要）
描述 活頁簿的描述。 字串
displayName 活頁簿的使用者定義名稱（顯示名稱）。 字串 （必要）
serializedData 此特定活頁簿的設定。 設定數據是包含有效 JSON 的字串 字串 （必要）
sourceId 來源資源的 ResourceId。 字串
storageUri 使用您自己的記憶體時，將 resourceId 複製到記憶體帳戶 字串
標籤 已被取代，請使用其他標籤欄位 string[]
版本 活頁簿架構版本格式，例如 『Notebook/1.0』，這應該符合 serializedData 中的活頁簿 字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
FinOps 工具組活頁簿

部署至 Azure 		此範本會建立新的 Azure 監視器活頁簿以進行治理。

Terraform （AzAPI 提供者） 資源定義

活頁簿資源類型可以使用目標作業來部署：

  • 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.Insights/workbooks 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/workbooks@2023-06-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      category = "string"
      description = "string"
      displayName = "string"
      serializedData = "string"
      sourceId = "string"
      storageUri = "string"
      tags = [
        "string"
      ]
      version = "string"
    }
    kind = "shared"
    etag = "string"
  })
}

屬性值

練習冊

名字 描述 價值
類型 資源類型 “Microsoft.Insights/workbooks@2023-06-01”
名字 資源名稱 字串 （必要）
位置 資源所在的地理位置 字串 （必要）
parent_id 若要部署至資源群組，請使用該資源群組的標識碼。 字串 （必要）
標籤 資源標籤。 標記名稱和值的字典。
類 活頁簿的種類。 只有有效的值是共用的。 “shared”
etag 資源 etag 字串
身份 用於 BYOS 的身分識別 WorkbookResourceIdentity
性能 描述 Azure 資源的活頁簿的元數據。 WorkbookProperties

WorkbookResourceIdentity

名字 描述 價值
類型 受控服務識別的類型（允許 SystemAssigned 和 UserAssigned 類型）。 “SystemAssigned”
“SystemAssigned，UserAssigned”
“UserAssigned” （必要）
identity_ids 與資源相關聯的使用者指派身分識別集。 userAssignedIdentities 字典索引鍵的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是要求中的空白物件（{}）。 使用者身分識別標識碼的陣列。

UserAssignedIdentities

名字 描述 價值
{自定義屬性} UserAssignedIdentity

UserAssignedIdentity

此物件不包含在部署期間設定的任何屬性。 所有屬性都是 ReadOnly。

WorkbookProperties

名字 描述 價值
類別 活頁簿類別，如使用者在建立時所定義。 字串 （必要）
描述 活頁簿的描述。 字串
displayName 活頁簿的使用者定義名稱（顯示名稱）。 字串 （必要）
serializedData 此特定活頁簿的設定。 設定數據是包含有效 JSON 的字串 字串 （必要）
sourceId 來源資源的 ResourceId。 字串
storageUri 使用您自己的記憶體時，將 resourceId 複製到記憶體帳戶 字串
標籤 已被取代，請使用其他標籤欄位 string[]
版本 活頁簿架構版本格式，例如 『Notebook/1.0』，這應該符合 serializedData 中的活頁簿 字串