Welcome to Pulumi Registry, your window into the cloud. Read the announcement.

Azure Native

v1.42.0 published on Monday, Oct 25, 2021 by Pulumi

Workbook

An Application Insights workbook definition. API Version: 2020-10-20.

Example Usage

WorkbookAdd

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var workbook = new AzureNative.Insights.Workbook("workbook", new AzureNative.Insights.WorkbookArgs
        {
            Category = "workbook",
            DisplayName = "tttt",
            Id = "c0deea5e-3344-40f2-96f8-6f8e1c3b5722",
            Kind = "shared",
            Location = "west us",
            Name = "Blah Blah Blah",
            ResourceGroupName = "my-resource-group",
            ResourceName = "deadb33f-8bee-4d3b-a059-9be8dac93960",
            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/00000000-0000-0000-0000-00000000/resourcegroups/MyGroup",
            Tags = 
            {
                "TagSample01",
                "TagSample02",
            },
        });
    }

}

package main

import (
	insights "github.com/pulumi/pulumi-azure-native/sdk/go/azure/insights"
	"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"),
			DisplayName:       pulumi.String("tttt"),
			Id:                pulumi.String("c0deea5e-3344-40f2-96f8-6f8e1c3b5722"),
			Kind:              pulumi.String("shared"),
			Location:          pulumi.String("west us"),
			Name:              pulumi.String("Blah Blah Blah"),
			ResourceGroupName: pulumi.String("my-resource-group"),
			ResourceName:      pulumi.String("deadb33f-8bee-4d3b-a059-9be8dac93960"),
			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/00000000-0000-0000-0000-00000000/resourcegroups/MyGroup"),
			Tags: pulumi.StringArray{
				pulumi.String("TagSample01"),
				pulumi.String("TagSample02"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

import pulumi
import pulumi_azure_native as azure_native

workbook = azure_native.insights.Workbook("workbook",
    category="workbook",
    display_name="tttt",
    id="c0deea5e-3344-40f2-96f8-6f8e1c3b5722",
    kind="shared",
    location="west us",
    name="Blah Blah Blah",
    resource_group_name="my-resource-group",
    resource_name="deadb33f-8bee-4d3b-a059-9be8dac93960",
    serialized_data="{\"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}",
    source_id="/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/MyGroup",
    tags=[
        "TagSample01",
        "TagSample02",
    ])

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const workbook = new azure_native.insights.Workbook("workbook", {
    category: "workbook",
    displayName: "tttt",
    id: "c0deea5e-3344-40f2-96f8-6f8e1c3b5722",
    kind: "shared",
    location: "west us",
    name: "Blah Blah Blah",
    resourceGroupName: "my-resource-group",
    resourceName: "deadb33f-8bee-4d3b-a059-9be8dac93960",
    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/00000000-0000-0000-0000-00000000/resourcegroups/MyGroup",
    tags: [
        "TagSample01",
        "TagSample02",
    ],
});

WorkbookManagedAdd

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var workbook = new AzureNative.Insights.Workbook("workbook", new AzureNative.Insights.WorkbookArgs
        {
            Category = "workbook",
            DisplayName = "tttt",
            Etag = "\"4a00f78d-0000-0700-0000-5f8f616c1000\"",
            Id = "/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/MyGroup/providers/Microsoft.Insights/workbooks/e378d137-1243-4256-b5c4-ad2a937cae79",
            Identity = new AzureNative.Insights.Inputs.WorkbookManagedIdentityArgs
            {
                Type = "UserAssigned",
            },
            Kind = "shared",
            Location = "westus",
            Name = "e378d137-1243-4256-b5c4-ad2a937cae79",
            ResourceGroupName = "my-resource-group",
            ResourceName = "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2",
            SerializedData = "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":{\"json\":\"test\"},\"name\":\"text - 0\"}],\"isLocked\":false,\"fallbackResourceIds\":[\"/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/MyGroup\"]}",
            SourceId = "/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/MyGroup",
            StorageUri = "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/MyGroup/providers/Microsoft.Storage/storageAccounts/testStorage/blobServices/default/containers/testContainer",
            Tags = 
            {
                { "hidden-title", "tttt" },
            },
            Version = "Notebook/1.0",
        });
    }

}

package main

import (
	insights "github.com/pulumi/pulumi-azure-native/sdk/go/azure/insights"
	"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"),
			DisplayName: pulumi.String("tttt"),
			Etag:        pulumi.StringMap("\"4a00f78d-0000-0700-0000-5f8f616c1000\""),
			Id:          pulumi.String("/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/MyGroup/providers/Microsoft.Insights/workbooks/e378d137-1243-4256-b5c4-ad2a937cae79"),
			Identity: &insights.WorkbookManagedIdentityArgs{
				Type: pulumi.String("UserAssigned"),
			},
			Kind:              pulumi.String("shared"),
			Location:          pulumi.String("westus"),
			Name:              pulumi.String("e378d137-1243-4256-b5c4-ad2a937cae79"),
			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\":\"test\"},\"name\":\"text - 0\"}],\"isLocked\":false,\"fallbackResourceIds\":[\"/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/MyGroup\"]}"),
			SourceId:          pulumi.String("/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/MyGroup"),
			StorageUri:        pulumi.String("/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/MyGroup/providers/Microsoft.Storage/storageAccounts/testStorage/blobServices/default/containers/testContainer"),
			Tags: pulumi.StringMap{
				"hidden-title": pulumi.String("tttt"),
			},
			Version: pulumi.String("Notebook/1.0"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

import pulumi
import pulumi_azure_native as azure_native

workbook = azure_native.insights.Workbook("workbook",
    category="workbook",
    display_name="tttt",
    etag="\"4a00f78d-0000-0700-0000-5f8f616c1000\"",
    id="/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/MyGroup/providers/Microsoft.Insights/workbooks/e378d137-1243-4256-b5c4-ad2a937cae79",
    identity=azure_native.insights.WorkbookManagedIdentityArgs(
        type="UserAssigned",
    ),
    kind="shared",
    location="westus",
    name="e378d137-1243-4256-b5c4-ad2a937cae79",
    resource_group_name="my-resource-group",
    resource_name="deadb33f-5e0d-4064-8ebb-1a4ed0313eb2",
    serialized_data="{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":{\"json\":\"test\"},\"name\":\"text - 0\"}],\"isLocked\":false,\"fallbackResourceIds\":[\"/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/MyGroup\"]}",
    source_id="/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/MyGroup",
    storage_uri="/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/MyGroup/providers/Microsoft.Storage/storageAccounts/testStorage/blobServices/default/containers/testContainer",
    tags={
        "hidden-title": "tttt",
    },
    version="Notebook/1.0")

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const workbook = new azure_native.insights.Workbook("workbook", {
    category: "workbook",
    displayName: "tttt",
    etag: "\"4a00f78d-0000-0700-0000-5f8f616c1000\"",
    id: "/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/MyGroup/providers/Microsoft.Insights/workbooks/e378d137-1243-4256-b5c4-ad2a937cae79",
    identity: {
        type: "UserAssigned",
    },
    kind: "shared",
    location: "westus",
    name: "e378d137-1243-4256-b5c4-ad2a937cae79",
    resourceGroupName: "my-resource-group",
    resourceName: "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2",
    serializedData: "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":{\"json\":\"test\"},\"name\":\"text - 0\"}],\"isLocked\":false,\"fallbackResourceIds\":[\"/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/MyGroup\"]}",
    sourceId: "/subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/MyGroup",
    storageUri: "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/MyGroup/providers/Microsoft.Storage/storageAccounts/testStorage/blobServices/default/containers/testContainer",
    tags: {
        "hidden-title": "tttt",
    },
    version: "Notebook/1.0",
});

Create a Workbook Resource

new Workbook(name: string, args: WorkbookArgs, opts?: CustomResourceOptions);
@overload
def Workbook(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             category: Optional[str] = None,
             display_name: Optional[str] = None,
             etag: Optional[Mapping[str, str]] = None,
             id: Optional[str] = None,
             identity: Optional[WorkbookManagedIdentityArgs] = None,
             kind: Optional[Union[str, Kind]] = None,
             location: Optional[str] = None,
             name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             resource_name_: Optional[str] = None,
             serialized_data: Optional[str] = None,
             source_id: Optional[str] = None,
             storage_uri: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None,
             type: Optional[str] = None,
             version: Optional[str] = None)
@overload
def Workbook(resource_name: str,
             args: WorkbookArgs,
             opts: Optional[ResourceOptions] = None)
func NewWorkbook(ctx *Context, name string, args WorkbookArgs, opts ...ResourceOption) (*Workbook, error)
public Workbook(string name, WorkbookArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args WorkbookArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args WorkbookArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args WorkbookArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args WorkbookArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Workbook Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Workbook resource accepts the following input properties:

Category string
Workbook category, as defined by the user at creation time.
DisplayName string
The user-defined name (display name) of the workbook.
ResourceGroupName string
The name of the resource group. The name is case insensitive.
SerializedData string
Configuration of this particular workbook. Configuration data is a string containing valid JSON
Etag Dictionary<string, string>
Resource etag
Id string
Azure resource Id
Identity Pulumi.AzureNative.Insights.Inputs.WorkbookManagedIdentityArgs
Identity used for BYOS
Kind string | Pulumi.AzureNative.Insights.Kind
The kind of workbook. Choices are user and shared.
Location string
Resource location
Name string
Azure resource name
ResourceName string
The name of the Application Insights component resource.
SourceId string
ResourceId for a source resource.
StorageUri string
BYOS Storage Account URI
Tags Dictionary<string, string>
Resource tags
Type string
Azure resource type
Version string
Workbook version
Category string
Workbook category, as defined by the user at creation time.
DisplayName string
The user-defined name (display name) of the workbook.
ResourceGroupName string
The name of the resource group. The name is case insensitive.
SerializedData string
Configuration of this particular workbook. Configuration data is a string containing valid JSON
Etag map[string]string
Resource etag
Id string
Azure resource Id
Identity WorkbookManagedIdentityArgs
Identity used for BYOS
Kind string | Kind
The kind of workbook. Choices are user and shared.
Location string
Resource location
Name string
Azure resource name
ResourceName string
The name of the Application Insights component resource.
SourceId string
ResourceId for a source resource.
StorageUri string
BYOS Storage Account URI
Tags map[string]string
Resource tags
Type string
Azure resource type
Version string
Workbook version
category string
Workbook category, as defined by the user at creation time.
displayName string
The user-defined name (display name) of the workbook.
resourceGroupName string
The name of the resource group. The name is case insensitive.
serializedData string
Configuration of this particular workbook. Configuration data is a string containing valid JSON
etag {[key: string]: string}
Resource etag
id string
Azure resource Id
identity WorkbookManagedIdentityArgs
Identity used for BYOS
kind string | Kind
The kind of workbook. Choices are user and shared.
location string
Resource location
name string
Azure resource name
resourceName string
The name of the Application Insights component resource.
sourceId string
ResourceId for a source resource.
storageUri string
BYOS Storage Account URI
tags {[key: string]: string}
Resource tags
type string
Azure resource type
version string
Workbook version
category str
Workbook category, as defined by the user at creation time.
display_name str
The user-defined name (display name) of the workbook.
resource_group_name str
The name of the resource group. The name is case insensitive.
serialized_data str
Configuration of this particular workbook. Configuration data is a string containing valid JSON
etag Mapping[str, str]
Resource etag
id str
Azure resource Id
identity WorkbookManagedIdentityArgs
Identity used for BYOS
kind str | Kind
The kind of workbook. Choices are user and shared.
location str
Resource location
name str
Azure resource name
resource_name str
The name of the Application Insights component resource.
source_id str
ResourceId for a source resource.
storage_uri str
BYOS Storage Account URI
tags Mapping[str, str]
Resource tags
type str
Azure resource type
version str
Workbook version

Outputs

All input properties are implicitly available as output properties. Additionally, the Workbook resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
TimeModified string
Date and time in UTC of the last modification that was made to this workbook definition.
UserId string
Unique user id of the specific user that owns this workbook.
Id string
The provider-assigned unique ID for this managed resource.
TimeModified string
Date and time in UTC of the last modification that was made to this workbook definition.
UserId string
Unique user id of the specific user that owns this workbook.
id string
The provider-assigned unique ID for this managed resource.
timeModified string
Date and time in UTC of the last modification that was made to this workbook definition.
userId string
Unique user id of the specific user that owns this workbook.
id str
The provider-assigned unique ID for this managed resource.
time_modified str
Date and time in UTC of the last modification that was made to this workbook definition.
user_id str
Unique user id of the specific user that owns this workbook.

Supporting Types

Kind

User
user
Shared
shared
KindUser
user
KindShared
shared
User
user
Shared
shared
USER
user
SHARED
shared

WorkbookManagedIdentity

Type string
The identity type.
Type string
The identity type.
type string
The identity type.
type str
The identity type.

WorkbookManagedIdentityResponse

Type string
The identity type.
UserAssignedIdentities WorkbookUserAssignedIdentitiesResponse
Customer Managed Identity
type string
The identity type.
userAssignedIdentities WorkbookUserAssignedIdentitiesResponse
Customer Managed Identity
type str
The identity type.
user_assigned_identities WorkbookUserAssignedIdentitiesResponse
Customer Managed Identity

WorkbookUserAssignedIdentitiesResponse

ClientId string
The client ID of resource.
PrincipalId string
The principal ID of resource identity.
TenantId string
The tenant ID of resource.
ClientId string
The client ID of resource.
PrincipalId string
The principal ID of resource identity.
TenantId string
The tenant ID of resource.
clientId string
The client ID of resource.
principalId string
The principal ID of resource identity.
tenantId string
The tenant ID of resource.
client_id str
The client ID of resource.
principal_id str
The principal ID of resource identity.
tenant_id str
The tenant ID of resource.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:insights:Workbook e378d137-1243-4256-b5c4-ad2a937cae79 /subscriptions/00000000-0000-0000-0000-00000000/resourcegroups/MyGroup/providers/Microsoft.Insights/workbooks/72377f0c-b7e7-4044-a882-471bcbd9696e 

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0