Microsoft.Insights workbooks 2020-10-20

Template format

To create a Microsoft.Insights/workbooks resource, add the following JSON to the resources section of your template.

{
  "name": "string",
  "type": "Microsoft.Insights/workbooks",
  "apiVersion": "2020-10-20",
  "identity": {
    "userAssignedIdentities": {},
    "type": "string"
  },
  "id": "string",
  "location": "string",
  "tags": {},
  "kind": "string",
  "properties": {
    "displayName": "string",
    "serializedData": "string",
    "version": "string",
    "category": "string",
    "tags": [
      "string"
    ],
    "sourceId": "string",
    "storageUri": "string"
  }
}

Property values

The following tables describe the values you need to set in the schema.

Microsoft.Insights/workbooks object

Note

In Bicep, type and apiVersion are specified in the first line of the resource declaration. Use the format <type>@<apiVersion>. Don't set those properties in the resource body.

Name Type Required Value
name string Yes The name of the Application Insights component resource.
type enum Yes For JSON - Microsoft.Insights/workbooks
apiVersion enum Yes For JSON - 2020-10-20
identity object No Identity used for BYOS - ManagedIdentity object
id string No Azure resource Id
location string No Resource location
tags object No Resource tags
kind enum No The kind of workbook. Choices are user and shared. - user or shared
properties object Yes Metadata describing a workbook for an Azure resource. - WorkbookProperties object

ManagedIdentity object

Name Type Required Value
userAssignedIdentities object No
type enum No The identity type. - UserAssigned or None

WorkbookProperties object

Name Type Required Value
displayName string Yes The user-defined name (display name) of the workbook.
serializedData string Yes Configuration of this particular workbook. Configuration data is a string containing valid JSON
version string No Workbook version
category string Yes Workbook category, as defined by the user at creation time.
tags array No A list of 0 or more tags that are associated with this workbook definition - string
sourceId string No ResourceId for a source resource.
storageUri string No BYOS Storage Account URI