Microsoft.Insights workbooks 2022-04-01

Bicep resource definition

The workbooks resource type can be deployed with operations that target:

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@2022-04-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'shared'
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    category: 'string'
    description: '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 The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
kind The kind of workbook. Only valid value is shared. 'shared'
etag Resource etag string
identity Identity used for BYOS WorkbookResourceIdentity
properties Metadata describing a workbook for an Azure resource. WorkbookProperties

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. object

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

ARM template resource definition

The workbooks resource type can be deployed with operations that target:

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": "2022-04-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "shared",
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "category": "string",
    "description": "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 '2022-04-01'
name The resource name string (required)
location The geo-location where the resource lives string (required)
tags Resource tags. Dictionary of tag names and values. See Tags in templates
kind The kind of workbook. Only valid value is shared. 'shared'
etag Resource etag string
identity Identity used for BYOS WorkbookResourceIdentity
properties Metadata describing a workbook for an Azure resource. WorkbookProperties

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. object

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

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@2022-04-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      category = "string"
      description = "string"
      displayName = "string"
      serializedData = "string"
      sourceId = "string"
      storageUri = "string"
      tags = [
        "string"
      ]
      version = "string"
    }
    kind = "shared"
    etag = "string"
  })
}

Property values

workbooks

Name Description Value
type The resource type "Microsoft.Insights/workbooks@2022-04-01"
name The resource name string (required)
location The geo-location where the resource lives string (required)
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. Only valid value is shared. "shared"
etag Resource etag string
identity Identity used for BYOS WorkbookResourceIdentity
properties Metadata describing a workbook for an Azure resource. WorkbookProperties

WorkbookResourceIdentity

Name Description Value
type Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (required)
identity_ids 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. Array of user identity IDs.

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