Microsoft.Insights workbooks 2020-10-20

• Latest
• 2023-06-01
• 2022-04-01
• 2021-08-01
• 2021-03-08
• 2020-10-20
• 2018-06-17-preview
• 2015-05-01

Bicep resource definition

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

• Resource groups - See resource group deployment commands

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@2020-10-20' = {
  etag: {
    {customized property}: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    category: 'string'
    displayName: 'string'
    serializedData: 'string'
    sourceId: 'string'
    storageUri: 'string'
    tags: [
      'string'
    ]
    version: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Insights/workbooks

Name	Description	Value
etag	Resource etag	ResourceEtag
identity	Identity used for BYOS	WorkbookManagedIdentity
kind	The kind of workbook. Choices are user and shared.	'shared' 'user'
location	Resource location	string
name	The resource name	string (required)
properties	Metadata describing a workbook for an Azure resource.	WorkbookProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

ResourceEtag

Name	Description	Value

ResourceTags

Name	Description	Value

WorkbookManagedIdentity

Name	Description	Value
type	The identity type.	'None' 'UserAssigned'
userAssignedIdentities	Customer Managed Identity	WorkbookUserAssignedIdentities

WorkbookProperties

Name	Description	Value
category	Workbook category, as defined by the user at creation time.	string (required)
displayName	The user-defined name (display name) of the workbook.	string (required)
serializedData	Configuration of this particular workbook. Configuration data is a string containing valid JSON	string (required)
sourceId	ResourceId for a source resource.	string
storageUri	BYOS Storage Account URI	string
tags	A list of 0 or more tags that are associated with this workbook definition	string[]
version	Workbook version	string

WorkbookUserAssignedIdentities

Name	Description	Value

Usage Examples

Azure Quickstart Samples

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

Bicep File	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.

ARM template resource definition

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

• Resource groups - See resource group deployment commands

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": "2020-10-20",
  "name": "string",
  "etag": {
    "{customized property}": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
    }
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "category": "string",
    "displayName": "string",
    "serializedData": "string",
    "sourceId": "string",
    "storageUri": "string",
    "tags": [ "string" ],
    "version": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Insights/workbooks

Name	Description	Value
apiVersion	The api version	'2020-10-20'
etag	Resource etag	ResourceEtag
identity	Identity used for BYOS	WorkbookManagedIdentity
kind	The kind of workbook. Choices are user and shared.	'shared' 'user'
location	Resource location	string
name	The resource name	string (required)
properties	Metadata describing a workbook for an Azure resource.	WorkbookProperties
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.Insights/workbooks'

ResourceEtag

Name	Description	Value

ResourceTags

Name	Description	Value

WorkbookManagedIdentity

Name	Description	Value
type	The identity type.	'None' 'UserAssigned'
userAssignedIdentities	Customer Managed Identity	WorkbookUserAssignedIdentities

WorkbookProperties

Name	Description	Value
category	Workbook category, as defined by the user at creation time.	string (required)
displayName	The user-defined name (display name) of the workbook.	string (required)
serializedData	Configuration of this particular workbook. Configuration data is a string containing valid JSON	string (required)
sourceId	ResourceId for a source resource.	string
storageUri	BYOS Storage Account URI	string
tags	A list of 0 or more tags that are associated with this workbook definition	string[]
version	Workbook version	string

WorkbookUserAssignedIdentities

Name	Description	Value

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:

• Resource groups

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@2020-10-20"
  name = "string"
  etag = {
    {customized property} = "string"
  }
  identity = {
    type = "string"
    userAssignedIdentities = {
    }
  }
  kind = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      category = "string"
      displayName = "string"
      serializedData = "string"
      sourceId = "string"
      storageUri = "string"
      tags = [
        "string"
      ]
      version = "string"
    }
  })
}

Property Values

Microsoft.Insights/workbooks

Name	Description	Value
etag	Resource etag	ResourceEtag
identity	Identity used for BYOS	WorkbookManagedIdentity
kind	The kind of workbook. Choices are user and shared.	'shared' 'user'
location	Resource location	string
name	The resource name	string (required)
properties	Metadata describing a workbook for an Azure resource.	WorkbookProperties
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.Insights/workbooks@2020-10-20"

ResourceEtag

Name	Description	Value

ResourceTags

Name	Description	Value

WorkbookManagedIdentity

Name	Description	Value
type	The identity type.	'None' 'UserAssigned'
userAssignedIdentities	Customer Managed Identity	WorkbookUserAssignedIdentities

WorkbookProperties

Name	Description	Value
category	Workbook category, as defined by the user at creation time.	string (required)
displayName	The user-defined name (display name) of the workbook.	string (required)
serializedData	Configuration of this particular workbook. Configuration data is a string containing valid JSON	string (required)
sourceId	ResourceId for a source resource.	string
storageUri	BYOS Storage Account URI	string
tags	A list of 0 or more tags that are associated with this workbook definition	string[]
version	Workbook version	string

WorkbookUserAssignedIdentities

Name	Description	Value