Workbook Args
data class WorkbookArgs(val category: Output<String>? = null, val description: Output<String>? = null, val displayName: Output<String>? = null, val identity: Output<WorkbookResourceIdentityArgs>? = null, val kind: Output<Either<String, WorkbookSharedTypeKind>>? = null, val location: Output<String>? = null, val resourceGroupName: Output<String>? = null, val resourceName: Output<String>? = null, val serializedData: Output<String>? = null, val sourceId: Output<String>? = null, val storageUri: Output<String>? = null, val tags: Output<Map<String, String>>? = null, val version: Output<String>? = null) : ConvertibleToJava<WorkbookArgs>
A workbook definition. Uses Azure REST API version 2022-04-01. In version 1.x of the Azure Native provider, it used API version 2020-10-20. Other available API versions: 2015-05-01, 2021-03-08, 2021-08-01, 2023-06-01.
Example Usage
WorkbookAdd
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var workbook = new AzureNative.Insights.Workbook("workbook", new()
{
Category = "workbook",
Description = "Sample workbook",
DisplayName = "Sample workbook",
Kind = AzureNative.Insights.WorkbookSharedTypeKind.Shared,
Location = "westus",
ResourceGroupName = "my-resource-group",
ResourceName = "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2",
SerializedData = "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook. This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\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.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}",
SourceId = "/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourcegroups/my-resource-group",
Tags =
{
{ "TagSample01", "sample01" },
{ "TagSample02", "sample02" },
},
});
});
Content copied to clipboard
package main
import (
insights "github.com/pulumi/pulumi-azure-native-sdk/insights/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := insights.NewWorkbook(ctx, "workbook", &insights.WorkbookArgs{
Category: pulumi.String("workbook"),
Description: pulumi.String("Sample workbook"),
DisplayName: pulumi.String("Sample workbook"),
Kind: pulumi.String(insights.WorkbookSharedTypeKindShared),
Location: pulumi.String("westus"),
ResourceGroupName: pulumi.String("my-resource-group"),
ResourceName: pulumi.String("deadb33f-5e0d-4064-8ebb-1a4ed0313eb2"),
SerializedData: pulumi.String("{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook. This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\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.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}"),
SourceId: pulumi.String("/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourcegroups/my-resource-group"),
Tags: pulumi.StringMap{
"TagSample01": pulumi.String("sample01"),
"TagSample02": pulumi.String("sample02"),
},
})
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.insights.Workbook;
import com.pulumi.azurenative.insights.WorkbookArgs;
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 workbook = new Workbook("workbook", WorkbookArgs.builder()
.category("workbook")
.description("Sample workbook")
.displayName("Sample workbook")
.kind("shared")
.location("westus")
.resourceGroupName("my-resource-group")
.resourceName("deadb33f-5e0d-4064-8ebb-1a4ed0313eb2")
.serializedData("{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook. This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\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.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}")
.sourceId("/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourcegroups/my-resource-group")
.tags(Map.ofEntries(
Map.entry("TagSample01", "sample01"),
Map.entry("TagSample02", "sample02")
))
.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:insights:Workbook deadb33f-5e0d-4064-8ebb-1a4ed0313eb2 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/workbooks/{resourceName}
Content copied to clipboard
Constructors
Link copied to clipboard
constructor(category: Output<String>? = null, description: Output<String>? = null, displayName: Output<String>? = null, identity: Output<WorkbookResourceIdentityArgs>? = null, kind: Output<Either<String, WorkbookSharedTypeKind>>? = null, location: Output<String>? = null, resourceGroupName: Output<String>? = null, resourceName: Output<String>? = null, serializedData: Output<String>? = null, sourceId: Output<String>? = null, storageUri: Output<String>? = null, tags: Output<Map<String, String>>? = null, version: Output<String>? = null)
Properties
Link copied to clipboard
The description of the workbook.
Link copied to clipboard
The user-defined name (display name) of the workbook.
Link copied to clipboard
Identity used for BYOS
Link copied to clipboard
The kind of workbook. Only valid value is shared.
Link copied to clipboard
The name of the resource group. The name is case insensitive.
Link copied to clipboard
The name of the resource.
Link copied to clipboard
Configuration of this particular workbook. Configuration data is a string containing valid JSON
Link copied to clipboard
The resourceId to the storage account when bring your own storage is used