Workbook Template
An Application Insights workbook template definition. Uses Azure REST API version 2020-11-20. Other available API versions: 2019-10-17-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native applicationinsights [ApiVersion]
. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.
Example Usage
WorkbookTemplateAdd
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var workbookTemplate = new AzureNative.ApplicationInsights.WorkbookTemplate("workbookTemplate", new()
{
Author = "Contoso",
Galleries = new[]
{
new AzureNative.ApplicationInsights.Inputs.WorkbookTemplateGalleryArgs
{
Category = "Failures",
Name = "Simple Template",
Order = 100,
ResourceType = "microsoft.insights/components",
Type = "tsg",
},
},
Location = "west us",
Priority = 1,
ResourceGroupName = "my-resource-group",
ResourceName = "testtemplate2",
TemplateData = new Dictionary<string, object?>
{
["$schema"] = "https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json",
["items"] = new[]
{
new Dictionary<string, object?>
{
["content"] = new Dictionary<string, object?>
{
["json"] = @"## New workbook
---
Welcome to your new workbook. This area will display text formatted as markdown.
We've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.",
},
["name"] = "text - 2",
["type"] = 1,
},
new Dictionary<string, object?>
{
["content"] = new Dictionary<string, object?>
{
["exportToExcelOptions"] = "visible",
["query"] = @"union withsource=TableName *
| summarize Count=count() by TableName
| render barchart",
["queryType"] = 0,
["resourceType"] = "microsoft.operationalinsights/workspaces",
["size"] = 1,
["version"] = "KqlItem/1.0",
},
["name"] = "query - 2",
["type"] = 3,
},
},
["styleSettings"] = new Dictionary<string, object?>
{
},
["version"] = "Notebook/1.0",
},
});
});
Content copied to clipboard
package main
import (
applicationinsights "github.com/pulumi/pulumi-azure-native-sdk/applicationinsights/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := applicationinsights.NewWorkbookTemplate(ctx, "workbookTemplate", &applicationinsights.WorkbookTemplateArgs{
Author: pulumi.String("Contoso"),
Galleries: applicationinsights.WorkbookTemplateGalleryArray{
&applicationinsights.WorkbookTemplateGalleryArgs{
Category: pulumi.String("Failures"),
Name: pulumi.String("Simple Template"),
Order: pulumi.Int(100),
ResourceType: pulumi.String("microsoft.insights/components"),
Type: pulumi.String("tsg"),
},
},
Location: pulumi.String("west us"),
Priority: pulumi.Int(1),
ResourceGroupName: pulumi.String("my-resource-group"),
ResourceName: pulumi.String("testtemplate2"),
TemplateData: pulumi.Any(map[string]interface{}{
"$schema": "https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json",
"items": []interface{}{
map[string]interface{}{
"content": map[string]interface{}{
"json": "## New workbook\n---\n\nWelcome to your new workbook. This area will display text formatted as markdown.\n\n\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.",
},
"name": "text - 2",
"type": 1,
},
map[string]interface{}{
"content": map[string]interface{}{
"exportToExcelOptions": "visible",
"query": "union withsource=TableName *\n| summarize Count=count() by TableName\n| render barchart",
"queryType": 0,
"resourceType": "microsoft.operationalinsights/workspaces",
"size": 1,
"version": "KqlItem/1.0",
},
"name": "query - 2",
"type": 3,
},
},
"styleSettings": map[string]interface{}{},
"version": "Notebook/1.0",
}),
})
if err != nil {
return err
}
return nil
})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.applicationinsights.WorkbookTemplate;
import com.pulumi.azurenative.applicationinsights.WorkbookTemplateArgs;
import com.pulumi.azurenative.applicationinsights.inputs.WorkbookTemplateGalleryArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var workbookTemplate = new WorkbookTemplate("workbookTemplate", WorkbookTemplateArgs.builder()
.author("Contoso")
.galleries(WorkbookTemplateGalleryArgs.builder()
.category("Failures")
.name("Simple Template")
.order(100)
.resourceType("microsoft.insights/components")
.type("tsg")
.build())
.location("west us")
.priority(1)
.resourceGroupName("my-resource-group")
.resourceName("testtemplate2")
.templateData(Map.ofEntries(
Map.entry("$schema", "https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json"),
Map.entry("items",
Map.ofEntries(
Map.entry("content", Map.of("json", """
## New workbook
---
Welcome to your new workbook. This area will display text formatted as markdown.
We've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections. """)),
Map.entry("name", "text - 2"),
Map.entry("type", 1)
),
Map.ofEntries(
Map.entry("content", Map.ofEntries(
Map.entry("exportToExcelOptions", "visible"),
Map.entry("query", """
union withsource=TableName *
| summarize Count=count() by TableName
| render barchart """),
Map.entry("queryType", 0),
Map.entry("resourceType", "microsoft.operationalinsights/workspaces"),
Map.entry("size", 1),
Map.entry("version", "KqlItem/1.0")
)),
Map.entry("name", "query - 2"),
Map.entry("type", 3)
)),
Map.entry("styleSettings", ),
Map.entry("version", "Notebook/1.0")
))
.build());
}
}
Content copied to clipboard
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:applicationinsights:WorkbookTemplate testtemplate2 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/workbooktemplates/{resourceName}
Content copied to clipboard