Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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
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.
| 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"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
etag = {
{customized property} = "string"
}
kind = "string"
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 |
|---|
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 = ["*"]
}