microsoft.insights workbooks 2018-06-17-preview

Bicep resource definition

The workbooks 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/workbooks resource, add the following Bicep to your template.

resource symbolicname 'microsoft.insights/workbooks@2018-06-17-preview' = {
  name: 'string'
}

Property Values

microsoft.insights/workbooks

Usage Examples

Bicep Samples

A basic example of deploying Azure Workbook.

param location string = 'westeurope'

resource workbook 'Microsoft.Insights/workbooks@2022-04-01' = {
  name: 'be1ad266-d329-4454-b693-8287e4d3b35d'
  location: location
  kind: 'shared'
  properties: {
    category: 'workbook'
    displayName: 'acctest-amw-230630032616547405'
    serializedData: '{"fallbackResourceIds":["Azure Monitor"],"isLocked":false,"items":[{"content":{"json":"Test2022"},"name":"text - 0","type":1}],"version":"Notebook/1.0"}'
    sourceId: 'azure monitor'
  }
}

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

ARM template resource definition

The workbooks 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/workbooks resource, add the following JSON to your template.

{
  "type": "microsoft.insights/workbooks",
  "apiVersion": "2018-06-17-preview",
  "name": "string"
}

Property Values

microsoft.insights/workbooks

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template	Description
Cost optimization workbook	This template creates a new Azure Monitor workbook for cost optimization based on the Well-Architected Framework.
FinOps toolkit workbook	This template creates a new Azure Monitor workbook for governance.

Terraform (AzAPI provider) resource definition

The workbooks 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/workbooks resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "microsoft.insights/workbooks@2018-06-17-preview"
  name = "string"
  parent_id = "string"
}

Property Values

microsoft.insights/workbooks

Usage Examples

Terraform Samples

A basic example of deploying Azure Workbook.

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" "workbook" {
  type      = "Microsoft.Insights/workbooks@2022-04-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = "be1ad266-d329-4454-b693-8287e4d3b35d"
  location  = var.location
  body = {
    kind = "shared"
    properties = {
      category       = "workbook"
      displayName    = "acctest-amw-230630032616547405"
      serializedData = "{\"fallbackResourceIds\":[\"Azure Monitor\"],\"isLocked\":false,\"items\":[{\"content\":{\"json\":\"Test2022\"},\"name\":\"text - 0\",\"type\":1}],\"version\":\"Notebook/1.0\"}"
      sourceId       = "azure monitor"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}