Microsoft.Insights workbooks
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@2023-06-01' = {
etag: 'string'
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
kind: 'string'
location: 'string'
name: 'string'
properties: {
category: 'string'
description: '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 | string |
| identity | Identity used for BYOS | WorkbookResourceIdentity |
| kind | The kind of workbook. Only valid value is shared. | 'shared' |
| location | The geo-location where the resource lives | string (required) |
| 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 |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
WorkbookProperties
| Name | Description | Value |
|---|---|---|
| category | Workbook category, as defined by the user at creation time. | string (required) |
| description | The description of the workbook. | string |
| 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 | The resourceId to the storage account when bring your own storage is used | string |
| tags | Being deprecated, please use the other tags field | string[] |
| version | Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData | string |
WorkbookResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
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": "2023-06-01",
"name": "string",
"etag": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"kind": "string",
"location": "string",
"properties": {
"category": "string",
"description": "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 | '2023-06-01' |
| etag | Resource etag | string |
| identity | Identity used for BYOS | WorkbookResourceIdentity |
| kind | The kind of workbook. Only valid value is shared. | 'shared' |
| location | The geo-location where the resource lives | string (required) |
| 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' |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
WorkbookProperties
| Name | Description | Value |
|---|---|---|
| category | Workbook category, as defined by the user at creation time. | string (required) |
| description | The description of the workbook. | string |
| 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 | The resourceId to the storage account when bring your own storage is used | string |
| tags | Being deprecated, please use the other tags field | string[] |
| version | Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData | string |
WorkbookResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |
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@2023-06-01"
name = "string"
etag = "string"
identity = {
type = "string"
userAssignedIdentities = {
{customized property} = {
}
}
}
kind = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
category = "string"
description = "string"
displayName = "string"
serializedData = "string"
sourceId = "string"
storageUri = "string"
tags = [
"string"
]
version = "string"
}
})
}
Property Values
Microsoft.Insights/workbooks
| Name | Description | Value |
|---|---|---|
| etag | Resource etag | string |
| identity | Identity used for BYOS | WorkbookResourceIdentity |
| kind | The kind of workbook. Only valid value is shared. | 'shared' |
| location | The geo-location where the resource lives | string (required) |
| 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@2023-06-01" |
TrackedResourceTags
| Name | Description | Value |
|---|
UserAssignedIdentities
| Name | Description | Value |
|---|
UserAssignedIdentity
| Name | Description | Value |
|---|
WorkbookProperties
| Name | Description | Value |
|---|---|---|
| category | Workbook category, as defined by the user at creation time. | string (required) |
| description | The description of the workbook. | string |
| 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 | The resourceId to the storage account when bring your own storage is used | string |
| tags | Being deprecated, please use the other tags field | string[] |
| version | Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData | string |
WorkbookResourceIdentity
| Name | Description | Value |
|---|---|---|
| type | Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). | 'None' 'SystemAssigned' 'SystemAssigned,UserAssigned' 'UserAssigned' (required) |
| userAssignedIdentities | The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests. | UserAssignedIdentities |