microsoft.insights workbooks 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@2015-05-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
kind: 'string'
properties: {
category: 'string'
kind: 'string'
name: 'string'
serializedData: 'string'
sourceResourceId: 'string'
tags: [
'string'
]
userId: 'string'
version: 'string'
workbookId: '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' |
| properties | Metadata describing a web test for an Azure resource. | WorkbookProperties |
WorkbookProperties
| Name | Description | Value |
|---|---|---|
| category | Workbook category, as defined by the user at creation time. | string (required) |
| kind | Enum indicating if this workbook definition is owned by a specific user or is shared between all users with access to the Application Insights component. | 'shared' 'user' (required) |
| name | The user-defined name of the workbook. | string (required) |
| serializedData | Configuration of this particular workbook. Configuration data is a string containing valid JSON | string (required) |
| sourceResourceId | Optional resourceId for a source resource. | string |
| tags | A list of 0 or more tags that are associated with this workbook definition | string[] |
| userId | Unique user id of the specific user that owns this workbook. | string (required) |
| version | This instance's version of the data model. This can change as new features are added that can be marked workbook. | string |
| workbookId | Internally assigned unique id of the workbook definition. | string (required) |
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": "2015-05-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"kind": "string",
"properties": {
"category": "string",
"kind": "string",
"name": "string",
"serializedData": "string",
"sourceResourceId": "string",
"tags": [ "string" ],
"userId": "string",
"version": "string",
"workbookId": "string"
}
}
Property values
workbooks
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'microsoft.insights/workbooks' |
| apiVersion | The resource api version | '2015-05-01' |
| 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' |
| properties | Metadata describing a web test for an Azure resource. | WorkbookProperties |
WorkbookProperties
| Name | Description | Value |
|---|---|---|
| category | Workbook category, as defined by the user at creation time. | string (required) |
| kind | Enum indicating if this workbook definition is owned by a specific user or is shared between all users with access to the Application Insights component. | 'shared' 'user' (required) |
| name | The user-defined name of the workbook. | string (required) |
| serializedData | Configuration of this particular workbook. Configuration data is a string containing valid JSON | string (required) |
| sourceResourceId | Optional resourceId for a source resource. | string |
| tags | A list of 0 or more tags that are associated with this workbook definition | string[] |
| userId | Unique user id of the specific user that owns this workbook. | string (required) |
| version | This instance's version of the data model. This can change as new features are added that can be marked workbook. | string |
| workbookId | Internally assigned unique id of the workbook definition. | string (required) |
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@2015-05-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
category = "string"
kind = "string"
name = "string"
serializedData = "string"
sourceResourceId = "string"
tags = [
"string"
]
userId = "string"
version = "string"
workbookId = "string"
}
kind = "string"
})
}
Property values
workbooks
| Name | Description | Value |
|---|---|---|
| type | The resource type | "microsoft.insights/workbooks@2015-05-01" |
| 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" |
| properties | Metadata describing a web test for an Azure resource. | WorkbookProperties |
WorkbookProperties
| Name | Description | Value |
|---|---|---|
| category | Workbook category, as defined by the user at creation time. | string (required) |
| kind | Enum indicating if this workbook definition is owned by a specific user or is shared between all users with access to the Application Insights component. | "shared" "user" (required) |
| name | The user-defined name of the workbook. | string (required) |
| serializedData | Configuration of this particular workbook. Configuration data is a string containing valid JSON | string (required) |
| sourceResourceId | Optional resourceId for a source resource. | string |
| tags | A list of 0 or more tags that are associated with this workbook definition | string[] |
| userId | Unique user id of the specific user that owns this workbook. | string (required) |
| version | This instance's version of the data model. This can change as new features are added that can be marked workbook. | string |
| workbookId | Internally assigned unique id of the workbook definition. | string (required) |