Microsoft.Insights workbooktemplates

  • Article

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' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    author: 'string'
    galleries: [
      {
        category: 'string'
        name: 'string'
        order: int
        resourceType: 'string'
        type: 'string'
      }
    ]
    localized: {}
    priority: int
    templateData: any()
  }
}

Property values

workbooktemplates

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

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. object
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. For Bicep, you can use the any() function.(required)

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

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",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "author": "string",
    "galleries": [
      {
        "category": "string",
        "name": "string",
        "order": "int",
        "resourceType": "string",
        "type": "string"
      }
    ],
    "localized": {},
    "priority": "int",
    "templateData": {}
  }
}

Property values

workbooktemplates

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

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. object
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.

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

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"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      author = "string"
      galleries = [
        {
          category = "string"
          name = "string"
          order = int
          resourceType = "string"
          type = "string"
        }
      ]
      localized = {}
      priority = int
    }
  })
}

Property values

workbooktemplates

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

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. object
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.

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