Microsoft.Insights workbooks 2020-10-20
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' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
kind: 'string'
etag: {
{customized property}: 'string'
}
identity: {
type: 'string'
userAssignedIdentities: {}
}
properties: {
category: 'string'
displayName: 'string'
serializedData: 'string'
sourceId: 'string'
storageUri: 'string'
tags: [
'string'
]
version: 'string'
}
}
Property values
workbooks
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| location | Resource location | string |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| kind | The kind of workbook. Choices are user and shared. | 'shared' 'user' |
| etag | Resource etag | ResourceEtag |
| identity | Identity used for BYOS | WorkbookManagedIdentity |
| properties | Metadata describing a workbook for an Azure resource. | WorkbookProperties |
ResourceEtag
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
WorkbookManagedIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'UserAssigned' |
| userAssignedIdentities | Customer Managed Identity | WorkbookUserAssignedIdentities |
WorkbookUserAssignedIdentities
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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 |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
FinOps toolkit workbook |
This template creates a new Azure Monitor workbook for governance. |
| Cost optimization workbook |
This template creates a new Azure Monitor workbook for cost optimization based on the Well-Architected Framework. |
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",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"kind": "string",
"etag": {
"{customized property}": "string"
},
"identity": {
"type": "string",
"userAssignedIdentities": {}
},
"properties": {
"category": "string",
"displayName": "string",
"serializedData": "string",
"sourceId": "string",
"storageUri": "string",
"tags": [ "string" ],
"version": "string"
}
}
Property values
workbooks
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.Insights/workbooks' |
| apiVersion | The resource api version | '2020-10-20' |
| name | The resource name | string (required) |
| location | Resource location | string |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| kind | The kind of workbook. Choices are user and shared. | 'shared' 'user' |
| etag | Resource etag | ResourceEtag |
| identity | Identity used for BYOS | WorkbookManagedIdentity |
| properties | Metadata describing a workbook for an Azure resource. | WorkbookProperties |
ResourceEtag
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
WorkbookManagedIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | 'None' 'UserAssigned' |
| userAssignedIdentities | Customer Managed Identity | WorkbookUserAssignedIdentities |
WorkbookUserAssignedIdentities
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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 |
Quickstart templates
The following quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| FinOps toolkit workbook |
This template creates a new Azure Monitor workbook for governance. |
| Cost optimization workbook |
This template creates a new Azure Monitor workbook for cost optimization based on the Well-Architected Framework. |
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"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "UserAssigned"
identity_ids = []
}
body = jsonencode({
properties = {
category = "string"
displayName = "string"
serializedData = "string"
sourceId = "string"
storageUri = "string"
tags = [
"string"
]
version = "string"
}
kind = "string"
etag = {
{customized property} = "string"
}
})
}
Property values
workbooks
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.Insights/workbooks@2020-10-20" |
| name | The resource name | string (required) |
| location | Resource location | string |
| 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. |
| kind | The kind of workbook. Choices are user and shared. | "shared" "user" |
| etag | Resource etag | ResourceEtag |
| identity | Identity used for BYOS | WorkbookManagedIdentity |
| properties | Metadata describing a workbook for an Azure resource. | WorkbookProperties |
ResourceEtag
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
WorkbookManagedIdentity
| Name | Description | Value |
|---|---|---|
| type | The identity type. | "UserAssigned" |
| identity_ids | Customer Managed Identity | Array of user identity IDs. |
WorkbookUserAssignedIdentities
This object doesn't contain any properties to set during deployment. All properties are ReadOnly.
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 |