Microsoft.Insights workbooktemplates

Bicep resource definition

The workbooktemplates resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Insights/workbooktemplates resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Insights/workbooktemplates@2020-11-20' = {
  location: 'string'
  name: 'string'
  properties: {
    author: 'string'
    galleries: [
      {
        category: 'string'
        name: 'string'
        order: int
        resourceType: 'string'
        type: 'string'
      }
    ]
    localized: {
      {customized property}: [
        {
          galleries: [
            {
              category: 'string'
              name: 'string'
              order: int
              resourceType: 'string'
              type: 'string'
            }
          ]
          templateData: any(...)
        }
      ]
    }
    priority: int
    templateData: any(...)
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Insights/workbooktemplates

Name Description Value
location Resource location string (required)
name The resource name string (required)
properties Metadata describing a workbook template for an Azure resource. WorkbookTemplateProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

WorkbookTemplateGallery

Name Description Value
category Category for the gallery. string
name Name of the workbook template in the gallery. string
order Order of the template within the gallery. int
resourceType Azure resource type supported by the gallery. string
type Type of workbook supported by the workbook template. string

WorkbookTemplateLocalizedGallery

Name Description Value
galleries Workbook galleries supported by the template. WorkbookTemplateGallery[]
templateData Valid JSON object containing workbook template payload. any

WorkbookTemplateProperties

Name Description Value
author Information about the author of the workbook template. string
galleries Workbook galleries supported by the template. WorkbookTemplateGallery[] (required)
localized Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal. WorkbookTemplatePropertiesLocalized
priority Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode. int
templateData Valid JSON object containing workbook template payload. any (required)

WorkbookTemplatePropertiesLocalized

Name Description Value

WorkbookTemplateResourceTags

Name Description Value

Usage Examples

Bicep Samples

A basic example of deploying Application Insights Workbook Template.

param resourceName string = 'acctest0001'
param location string = 'westeurope'

resource workbookTemplate 'Microsoft.Insights/workbookTemplates@2020-11-20' = {
  name: resourceName
  location: location
  properties: {
    galleries: [
      {
        category: 'workbook'
        name: 'test'
        order: 0
        resourceType: 'Azure Monitor'
        type: 'workbook'
      }
    ]
    priority: 0
    templateData: {
      '$schema': 'https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json'
      items: [
        {
          content: {
            json: '''## New workbook
---

Welcome to your new workbook.'''
          }
          name: 'text - 2'
          type: 1
        }
      ]
      styleSettings: {}
      version: 'Notebook/1.0'
    }
  }
}

ARM template resource definition

The workbooktemplates resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Insights/workbooktemplates resource, add the following JSON to your template.

{
  "type": "Microsoft.Insights/workbooktemplates",
  "apiVersion": "2020-11-20",
  "name": "string",
  "location": "string",
  "properties": {
    "author": "string",
    "galleries": [
      {
        "category": "string",
        "name": "string",
        "order": "int",
        "resourceType": "string",
        "type": "string"
      }
    ],
    "localized": {
      "{customized property}": [
        {
          "galleries": [
            {
              "category": "string",
              "name": "string",
              "order": "int",
              "resourceType": "string",
              "type": "string"
            }
          ],
          "templateData": {}
        }
      ]
    },
    "priority": "int",
    "templateData": {}
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Insights/workbooktemplates

Name Description Value
apiVersion The api version '2020-11-20'
location Resource location string (required)
name The resource name string (required)
properties Metadata describing a workbook template for an Azure resource. WorkbookTemplateProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Insights/workbooktemplates'

WorkbookTemplateGallery

Name Description Value
category Category for the gallery. string
name Name of the workbook template in the gallery. string
order Order of the template within the gallery. int
resourceType Azure resource type supported by the gallery. string
type Type of workbook supported by the workbook template. string

WorkbookTemplateLocalizedGallery

Name Description Value
galleries Workbook galleries supported by the template. WorkbookTemplateGallery[]
templateData Valid JSON object containing workbook template payload. any

WorkbookTemplateProperties

Name Description Value
author Information about the author of the workbook template. string
galleries Workbook galleries supported by the template. WorkbookTemplateGallery[] (required)
localized Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal. WorkbookTemplatePropertiesLocalized
priority Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode. int
templateData Valid JSON object containing workbook template payload. any (required)

WorkbookTemplatePropertiesLocalized

Name Description Value

WorkbookTemplateResourceTags

Name Description Value

Usage Examples

Terraform (AzAPI provider) resource definition

The workbooktemplates resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Insights/workbooktemplates resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/workbooktemplates@2020-11-20"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      author = "string"
      galleries = [
        {
          category = "string"
          name = "string"
          order = int
          resourceType = "string"
          type = "string"
        }
      ]
      localized = {
        {customized property} = [
          {
            galleries = [
              {
                category = "string"
                name = "string"
                order = int
                resourceType = "string"
                type = "string"
              }
            ]
            templateData = ?
          }
        ]
      }
      priority = int
      templateData = ?
    }
  }
}

Property Values

Microsoft.Insights/workbooktemplates

Name Description Value
location Resource location string (required)
name The resource name string (required)
properties Metadata describing a workbook template for an Azure resource. WorkbookTemplateProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Insights/workbooktemplates@2020-11-20"

WorkbookTemplateGallery

Name Description Value
category Category for the gallery. string
name Name of the workbook template in the gallery. string
order Order of the template within the gallery. int
resourceType Azure resource type supported by the gallery. string
type Type of workbook supported by the workbook template. string

WorkbookTemplateLocalizedGallery

Name Description Value
galleries Workbook galleries supported by the template. WorkbookTemplateGallery[]
templateData Valid JSON object containing workbook template payload. any

WorkbookTemplateProperties

Name Description Value
author Information about the author of the workbook template. string
galleries Workbook galleries supported by the template. WorkbookTemplateGallery[] (required)
localized Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal. WorkbookTemplatePropertiesLocalized
priority Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode. int
templateData Valid JSON object containing workbook template payload. any (required)

WorkbookTemplatePropertiesLocalized

Name Description Value

WorkbookTemplateResourceTags

Name Description Value

Usage Examples

Terraform Samples

A basic example of deploying Application Insights Workbook Template.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "workbookTemplate" {
  type      = "Microsoft.Insights/workbookTemplates@2020-11-20"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      galleries = [
        {
          category     = "workbook"
          name         = "test"
          order        = 0
          resourceType = "Azure Monitor"
          type         = "workbook"
        },
      ]
      priority = 0
      templateData = {
        "$schema" = "https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json"
        items = [
          {
            content = {
              json = "## New workbook\n---\n\nWelcome to your new workbook."
            }
            name = "text - 2"
            type = 1
          },
        ]
        styleSettings = {
        }
        version = "Notebook/1.0"
      }
    }

  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}
  • Last updated on