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@2015-05-01' = {
kind: 'string'
location: 'string'
name: 'string'
properties: {
category: 'string'
kind: 'string'
name: 'string'
serializedData: 'string'
sourceResourceId: 'string'
tags: [
'string'
]
userId: 'string'
version: 'string'
workbookId: 'string'
}
tags: {
{customized property}: 'string'
}
}
Property Values
microsoft.insights/workbooks
| Name | Description | Value |
|---|---|---|
| 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 web test for an Azure resource. | WorkbookProperties |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
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) |
WorkbookResourceTags
| 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": "2015-05-01",
"name": "string",
"kind": "string",
"location": "string",
"properties": {
"category": "string",
"kind": "string",
"name": "string",
"serializedData": "string",
"sourceResourceId": "string",
"tags": [ "string" ],
"userId": "string",
"version": "string",
"workbookId": "string"
},
"tags": {
"{customized property}": "string"
}
}
Property Values
microsoft.insights/workbooks
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2015-05-01' |
| 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 web test 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' |
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) |
WorkbookResourceTags
| 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@2015-05-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = {
kind = "string"
properties = {
category = "string"
kind = "string"
name = "string"
serializedData = "string"
sourceResourceId = "string"
tags = [
"string"
]
userId = "string"
version = "string"
workbookId = "string"
}
}
}
Property Values
microsoft.insights/workbooks
| Name | Description | Value |
|---|---|---|
| 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 web test for an Azure resource. | WorkbookProperties |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "microsoft.insights/workbooks@2015-05-01" |
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) |
WorkbookResourceTags
| Name | Description | Value |
|---|