Docs Packages
  1. Packages
  2. Azure Classic
  3. API Docs
  4. appinsights
  5. Workbook

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure

azure.appinsights.Workbook

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
pulumi/pulumi-azure

    Manages an Azure Workbook.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = new azure.core.ResourceGroup("example", {
    name: "example-resources",
    location: "West Europe",
});
const exampleWorkbook = new azure.appinsights.Workbook("example", {
    name: "85b3e8bb-fc93-40be-83f2-98f6bec18ba0",
    resourceGroupName: example.name,
    location: example.location,
    displayName: "workbook1",
    dataJson: JSON.stringify({
        version: "Notebook/1.0",
        items: [{
            type: 1,
            content: {
                json: "Test2022",
            },
            name: "text - 0",
        }],
        isLocked: false,
        fallbackResourceIds: ["Azure Monitor"],
    }),
    tags: {
        ENV: "Test",
    },
});

    import pulumi
import json
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_workbook = azure.appinsights.Workbook("example",
    name="85b3e8bb-fc93-40be-83f2-98f6bec18ba0",
    resource_group_name=example.name,
    location=example.location,
    display_name="workbook1",
    data_json=json.dumps({
        "version": "Notebook/1.0",
        "items": [{
            "type": 1,
            "content": {
                "json": "Test2022",
            },
            "name": "text - 0",
        }],
        "isLocked": False,
        "fallbackResourceIds": ["Azure Monitor"],
    }),
    tags={
        "ENV": "Test",
    })

    package main

import (
	"encoding/json"

	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/appinsights"
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"version": "Notebook/1.0",
			"items": []map[string]interface{}{
				map[string]interface{}{
					"type": 1,
					"content": map[string]interface{}{
						"json": "Test2022",
					},
					"name": "text - 0",
				},
			},
			"isLocked": false,
			"fallbackResourceIds": []string{
				"Azure Monitor",
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = appinsights.NewWorkbook(ctx, "example", &appinsights.WorkbookArgs{
			Name:              pulumi.String("85b3e8bb-fc93-40be-83f2-98f6bec18ba0"),
			ResourceGroupName: example.Name,
			Location:          example.Location,
			DisplayName:       pulumi.String("workbook1"),
			DataJson:          pulumi.String(json0),
			Tags: pulumi.StringMap{
				"ENV": pulumi.String("Test"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = new Azure.Core.ResourceGroup("example", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var exampleWorkbook = new Azure.AppInsights.Workbook("example", new()
    {
        Name = "85b3e8bb-fc93-40be-83f2-98f6bec18ba0",
        ResourceGroupName = example.Name,
        Location = example.Location,
        DisplayName = "workbook1",
        DataJson = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["version"] = "Notebook/1.0",
            ["items"] = new[]
            {
                new Dictionary<string, object?>
                {
                    ["type"] = 1,
                    ["content"] = new Dictionary<string, object?>
                    {
                        ["json"] = "Test2022",
                    },
                    ["name"] = "text - 0",
                },
            },
            ["isLocked"] = false,
            ["fallbackResourceIds"] = new[]
            {
                "Azure Monitor",
            },
        }),
        Tags = 
        {
            { "ENV", "Test" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.appinsights.Workbook;
import com.pulumi.azure.appinsights.WorkbookArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 example = new ResourceGroup("example", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var exampleWorkbook = new Workbook("exampleWorkbook", WorkbookArgs.builder()
            .name("85b3e8bb-fc93-40be-83f2-98f6bec18ba0")
            .resourceGroupName(example.name())
            .location(example.location())
            .displayName("workbook1")
            .dataJson(serializeJson(
                jsonObject(
                    jsonProperty("version", "Notebook/1.0"),
                    jsonProperty("items", jsonArray(jsonObject(
                        jsonProperty("type", 1),
                        jsonProperty("content", jsonObject(
                            jsonProperty("json", "Test2022")
                        )),
                        jsonProperty("name", "text - 0")
                    ))),
                    jsonProperty("isLocked", false),
                    jsonProperty("fallbackResourceIds", jsonArray("Azure Monitor"))
                )))
            .tags(Map.of("ENV", "Test"))
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleWorkbook:
    type: azure:appinsights:Workbook
    name: example
    properties:
      name: 85b3e8bb-fc93-40be-83f2-98f6bec18ba0
      resourceGroupName: ${example.name}
      location: ${example.location}
      displayName: workbook1
      dataJson:
        fn::toJSON:
          version: Notebook/1.0
          items:
            - type: 1
              content:
                json: Test2022
              name: text - 0
          isLocked: false
          fallbackResourceIds:
            - Azure Monitor
      tags:
        ENV: Test

    Create Workbook Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Workbook(name: string, args: WorkbookArgs, opts?: CustomResourceOptions);
    @overload
def Workbook(resource_name: str,
             args: WorkbookArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Workbook(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             data_json: Optional[str] = None,
             display_name: Optional[str] = None,
             resource_group_name: Optional[str] = None,
             category: Optional[str] = None,
             description: Optional[str] = None,
             identity: Optional[WorkbookIdentityArgs] = None,
             location: Optional[str] = None,
             name: Optional[str] = None,
             source_id: Optional[str] = None,
             storage_container_id: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None)
    func NewWorkbook(ctx *Context, name string, args WorkbookArgs, opts ...ResourceOption) (*Workbook, error)
    public Workbook(string name, WorkbookArgs args, CustomResourceOptions? opts = null)
    public Workbook(String name, WorkbookArgs args)
public Workbook(String name, WorkbookArgs args, CustomResourceOptions options)

    type: azure:appinsights:Workbook
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    name String
    The unique name of the resource.
    args WorkbookArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var workbookResource = new Azure.AppInsights.Workbook("workbookResource", new()
{
    DataJson = "string",
    DisplayName = "string",
    ResourceGroupName = "string",
    Category = "string",
    Description = "string",
    Identity = new Azure.AppInsights.Inputs.WorkbookIdentityArgs
    {
        Type = "string",
        IdentityIds = new[]
        {
            "string",
        },
        PrincipalId = "string",
        TenantId = "string",
    },
    Location = "string",
    Name = "string",
    SourceId = "string",
    StorageContainerId = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := appinsights.NewWorkbook(ctx, "workbookResource", &appinsights.WorkbookArgs{
	DataJson:          pulumi.String("string"),
	DisplayName:       pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	Category:          pulumi.String("string"),
	Description:       pulumi.String("string"),
	Identity: &appinsights.WorkbookIdentityArgs{
		Type: pulumi.String("string"),
		IdentityIds: pulumi.StringArray{
			pulumi.String("string"),
		},
		PrincipalId: pulumi.String("string"),
		TenantId:    pulumi.String("string"),
	},
	Location:           pulumi.String("string"),
	Name:               pulumi.String("string"),
	SourceId:           pulumi.String("string"),
	StorageContainerId: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var workbookResource = new Workbook("workbookResource", WorkbookArgs.builder()
    .dataJson("string")
    .displayName("string")
    .resourceGroupName("string")
    .category("string")
    .description("string")
    .identity(WorkbookIdentityArgs.builder()
        .type("string")
        .identityIds("string")
        .principalId("string")
        .tenantId("string")
        .build())
    .location("string")
    .name("string")
    .sourceId("string")
    .storageContainerId("string")
    .tags(Map.of("string", "string"))
    .build());

    workbook_resource = azure.appinsights.Workbook("workbookResource",
    data_json="string",
    display_name="string",
    resource_group_name="string",
    category="string",
    description="string",
    identity=azure.appinsights.WorkbookIdentityArgs(
        type="string",
        identity_ids=["string"],
        principal_id="string",
        tenant_id="string",
    ),
    location="string",
    name="string",
    source_id="string",
    storage_container_id="string",
    tags={
        "string": "string",
    })

    const workbookResource = new azure.appinsights.Workbook("workbookResource", {
    dataJson: "string",
    displayName: "string",
    resourceGroupName: "string",
    category: "string",
    description: "string",
    identity: {
        type: "string",
        identityIds: ["string"],
        principalId: "string",
        tenantId: "string",
    },
    location: "string",
    name: "string",
    sourceId: "string",
    storageContainerId: "string",
    tags: {
        string: "string",
    },
});

    type: azure:appinsights:Workbook
properties:
    category: string
    dataJson: string
    description: string
    displayName: string
    identity:
        identityIds:
            - string
        principalId: string
        tenantId: string
        type: string
    location: string
    name: string
    resourceGroupName: string
    sourceId: string
    storageContainerId: string
    tags:
        string: string

    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:

    DataJson string
    Configuration of this particular workbook. Configuration data is a string containing valid JSON.
    DisplayName string
    Specifies the user-defined name (display name) of the workbook.
    ResourceGroupName string
    Specifies the name of the Resource Group where the Workbook should exist. Changing this forces a new Workbook to be created.
    Category string
    Workbook category, as defined by the user at creation time. There may be additional category types beyond the following: workbook, sentinel. Defaults to workbook.
    Description string
    Specifies the description of the workbook.
    Identity WorkbookIdentity
    An identity block as defined below. Changing this forces a new Workbook to be created.
    Location string
    Specifies the Azure Region where the Workbook should exist. Changing this forces a new Workbook to be created.
    Name string
    Specifies the name of this Workbook as a UUID/GUID. It should not contain any uppercase letters. Changing this forces a new Workbook to be created.
    SourceId string
    Resource ID for a source resource. It should not contain any uppercase letters. Defaults to azure monitor.
    StorageContainerId string

    Specifies the Resource Manager ID of the Storage Container when bring your own storage is used. Changing this forces a new Workbook to be created.

    Note: This is the Resource Manager ID of the Storage Container, rather than the regular ID - and can be accessed on the azure.storage.Container Data Source/Resource as resource_manager_id.

    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Workbook.
    DataJson string
    Configuration of this particular workbook. Configuration data is a string containing valid JSON.
    DisplayName string
    Specifies the user-defined name (display name) of the workbook.
    ResourceGroupName string
    Specifies the name of the Resource Group where the Workbook should exist. Changing this forces a new Workbook to be created.
    Category string
    Workbook category, as defined by the user at creation time. There may be additional category types beyond the following: workbook, sentinel. Defaults to workbook.
    Description string
    Specifies the description of the workbook.
    Identity WorkbookIdentityArgs
    An identity block as defined below. Changing this forces a new Workbook to be created.
    Location string
    Specifies the Azure Region where the Workbook should exist. Changing this forces a new Workbook to be created.
    Name string
    Specifies the name of this Workbook as a UUID/GUID. It should not contain any uppercase letters. Changing this forces a new Workbook to be created.
    SourceId string
    Resource ID for a source resource. It should not contain any uppercase letters. Defaults to azure monitor.
    StorageContainerId string

    Specifies the Resource Manager ID of the Storage Container when bring your own storage is used. Changing this forces a new Workbook to be created.

    Note: This is the Resource Manager ID of the Storage Container, rather than the regular ID - and can be accessed on the azure.storage.Container Data Source/Resource as resource_manager_id.

    Tags map[string]string
    A mapping of tags which should be assigned to the Workbook.
    dataJson String
    Configuration of this particular workbook. Configuration data is a string containing valid JSON.
    displayName String
    Specifies the user-defined name (display name) of the workbook.
    resourceGroupName String
    Specifies the name of the Resource Group where the Workbook should exist. Changing this forces a new Workbook to be created.
    category String
    Workbook category, as defined by the user at creation time. There may be additional category types beyond the following: workbook, sentinel. Defaults to workbook.
    description String
    Specifies the description of the workbook.
    identity WorkbookIdentity
    An identity block as defined below. Changing this forces a new Workbook to be created.
    location String
    Specifies the Azure Region where the Workbook should exist. Changing this forces a new Workbook to be created.
    name String
    Specifies the name of this Workbook as a UUID/GUID. It should not contain any uppercase letters. Changing this forces a new Workbook to be created.
    sourceId String
    Resource ID for a source resource. It should not contain any uppercase letters. Defaults to azure monitor.
    storageContainerId String

    Specifies the Resource Manager ID of the Storage Container when bring your own storage is used. Changing this forces a new Workbook to be created.

    Note: This is the Resource Manager ID of the Storage Container, rather than the regular ID - and can be accessed on the azure.storage.Container Data Source/Resource as resource_manager_id.

    tags Map<String,String>
    A mapping of tags which should be assigned to the Workbook.
    dataJson string
    Configuration of this particular workbook. Configuration data is a string containing valid JSON.
    displayName string
    Specifies the user-defined name (display name) of the workbook.
    resourceGroupName string
    Specifies the name of the Resource Group where the Workbook should exist. Changing this forces a new Workbook to be created.
    category string
    Workbook category, as defined by the user at creation time. There may be additional category types beyond the following: workbook, sentinel. Defaults to workbook.
    description string
    Specifies the description of the workbook.
    identity WorkbookIdentity
    An identity block as defined below. Changing this forces a new Workbook to be created.
    location string
    Specifies the Azure Region where the Workbook should exist. Changing this forces a new Workbook to be created.
    name string
    Specifies the name of this Workbook as a UUID/GUID. It should not contain any uppercase letters. Changing this forces a new Workbook to be created.
    sourceId string
    Resource ID for a source resource. It should not contain any uppercase letters. Defaults to azure monitor.
    storageContainerId string

    Specifies the Resource Manager ID of the Storage Container when bring your own storage is used. Changing this forces a new Workbook to be created.

    Note: This is the Resource Manager ID of the Storage Container, rather than the regular ID - and can be accessed on the azure.storage.Container Data Source/Resource as resource_manager_id.

    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Workbook.
    data_json str
    Configuration of this particular workbook. Configuration data is a string containing valid JSON.
    display_name str
    Specifies the user-defined name (display name) of the workbook.
    resource_group_name str
    Specifies the name of the Resource Group where the Workbook should exist. Changing this forces a new Workbook to be created.
    category str
    Workbook category, as defined by the user at creation time. There may be additional category types beyond the following: workbook, sentinel. Defaults to workbook.
    description str
    Specifies the description of the workbook.
    identity WorkbookIdentityArgs
    An identity block as defined below. Changing this forces a new Workbook to be created.
    location str
    Specifies the Azure Region where the Workbook should exist. Changing this forces a new Workbook to be created.
    name str
    Specifies the name of this Workbook as a UUID/GUID. It should not contain any uppercase letters. Changing this forces a new Workbook to be created.
    source_id str
    Resource ID for a source resource. It should not contain any uppercase letters. Defaults to azure monitor.
    storage_container_id str

    Specifies the Resource Manager ID of the Storage Container when bring your own storage is used. Changing this forces a new Workbook to be created.

    Note: This is the Resource Manager ID of the Storage Container, rather than the regular ID - and can be accessed on the azure.storage.Container Data Source/Resource as resource_manager_id.

    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Workbook.
    dataJson String
    Configuration of this particular workbook. Configuration data is a string containing valid JSON.
    displayName String
    Specifies the user-defined name (display name) of the workbook.
    resourceGroupName String
    Specifies the name of the Resource Group where the Workbook should exist. Changing this forces a new Workbook to be created.
    category String
    Workbook category, as defined by the user at creation time. There may be additional category types beyond the following: workbook, sentinel. Defaults to workbook.
    description String
    Specifies the description of the workbook.
    identity Property Map
    An identity block as defined below. Changing this forces a new Workbook to be created.
    location String
    Specifies the Azure Region where the Workbook should exist. Changing this forces a new Workbook to be created.
    name String
    Specifies the name of this Workbook as a UUID/GUID. It should not contain any uppercase letters. Changing this forces a new Workbook to be created.
    sourceId String
    Resource ID for a source resource. It should not contain any uppercase letters. Defaults to azure monitor.
    storageContainerId String

    Specifies the Resource Manager ID of the Storage Container when bring your own storage is used. Changing this forces a new Workbook to be created.

    Note: This is the Resource Manager ID of the Storage Container, rather than the regular ID - and can be accessed on the azure.storage.Container Data Source/Resource as resource_manager_id.

    tags Map<String>
    A mapping of tags which should be assigned to the Workbook.

    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Workbook Resource

    Get an existing Workbook resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: WorkbookState, opts?: CustomResourceOptions): Workbook
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        category: Optional[str] = None,
        data_json: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        identity: Optional[WorkbookIdentityArgs] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        source_id: Optional[str] = None,
        storage_container_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> Workbook
    func GetWorkbook(ctx *Context, name string, id IDInput, state *WorkbookState, opts ...ResourceOption) (*Workbook, error)
    public static Workbook Get(string name, Input<string> id, WorkbookState? state, CustomResourceOptions? opts = null)
    public static Workbook get(String name, Output<String> id, WorkbookState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Category string
    Workbook category, as defined by the user at creation time. There may be additional category types beyond the following: workbook, sentinel. Defaults to workbook.
    DataJson string
    Configuration of this particular workbook. Configuration data is a string containing valid JSON.
    Description string
    Specifies the description of the workbook.
    DisplayName string
    Specifies the user-defined name (display name) of the workbook.
    Identity WorkbookIdentity
    An identity block as defined below. Changing this forces a new Workbook to be created.
    Location string
    Specifies the Azure Region where the Workbook should exist. Changing this forces a new Workbook to be created.
    Name string
    Specifies the name of this Workbook as a UUID/GUID. It should not contain any uppercase letters. Changing this forces a new Workbook to be created.
    ResourceGroupName string
    Specifies the name of the Resource Group where the Workbook should exist. Changing this forces a new Workbook to be created.
    SourceId string
    Resource ID for a source resource. It should not contain any uppercase letters. Defaults to azure monitor.
    StorageContainerId string

    Specifies the Resource Manager ID of the Storage Container when bring your own storage is used. Changing this forces a new Workbook to be created.

    Note: This is the Resource Manager ID of the Storage Container, rather than the regular ID - and can be accessed on the azure.storage.Container Data Source/Resource as resource_manager_id.

    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Workbook.
    Category string
    Workbook category, as defined by the user at creation time. There may be additional category types beyond the following: workbook, sentinel. Defaults to workbook.
    DataJson string
    Configuration of this particular workbook. Configuration data is a string containing valid JSON.
    Description string
    Specifies the description of the workbook.
    DisplayName string
    Specifies the user-defined name (display name) of the workbook.
    Identity WorkbookIdentityArgs
    An identity block as defined below. Changing this forces a new Workbook to be created.
    Location string
    Specifies the Azure Region where the Workbook should exist. Changing this forces a new Workbook to be created.
    Name string
    Specifies the name of this Workbook as a UUID/GUID. It should not contain any uppercase letters. Changing this forces a new Workbook to be created.
    ResourceGroupName string
    Specifies the name of the Resource Group where the Workbook should exist. Changing this forces a new Workbook to be created.
    SourceId string
    Resource ID for a source resource. It should not contain any uppercase letters. Defaults to azure monitor.
    StorageContainerId string

    Specifies the Resource Manager ID of the Storage Container when bring your own storage is used. Changing this forces a new Workbook to be created.

    Note: This is the Resource Manager ID of the Storage Container, rather than the regular ID - and can be accessed on the azure.storage.Container Data Source/Resource as resource_manager_id.

    Tags map[string]string
    A mapping of tags which should be assigned to the Workbook.
    category String
    Workbook category, as defined by the user at creation time. There may be additional category types beyond the following: workbook, sentinel. Defaults to workbook.
    dataJson String
    Configuration of this particular workbook. Configuration data is a string containing valid JSON.
    description String
    Specifies the description of the workbook.
    displayName String
    Specifies the user-defined name (display name) of the workbook.
    identity WorkbookIdentity
    An identity block as defined below. Changing this forces a new Workbook to be created.
    location String
    Specifies the Azure Region where the Workbook should exist. Changing this forces a new Workbook to be created.
    name String
    Specifies the name of this Workbook as a UUID/GUID. It should not contain any uppercase letters. Changing this forces a new Workbook to be created.
    resourceGroupName String
    Specifies the name of the Resource Group where the Workbook should exist. Changing this forces a new Workbook to be created.
    sourceId String
    Resource ID for a source resource. It should not contain any uppercase letters. Defaults to azure monitor.
    storageContainerId String

    Specifies the Resource Manager ID of the Storage Container when bring your own storage is used. Changing this forces a new Workbook to be created.

    Note: This is the Resource Manager ID of the Storage Container, rather than the regular ID - and can be accessed on the azure.storage.Container Data Source/Resource as resource_manager_id.

    tags Map<String,String>
    A mapping of tags which should be assigned to the Workbook.
    category string
    Workbook category, as defined by the user at creation time. There may be additional category types beyond the following: workbook, sentinel. Defaults to workbook.
    dataJson string
    Configuration of this particular workbook. Configuration data is a string containing valid JSON.
    description string
    Specifies the description of the workbook.
    displayName string
    Specifies the user-defined name (display name) of the workbook.
    identity WorkbookIdentity
    An identity block as defined below. Changing this forces a new Workbook to be created.
    location string
    Specifies the Azure Region where the Workbook should exist. Changing this forces a new Workbook to be created.
    name string
    Specifies the name of this Workbook as a UUID/GUID. It should not contain any uppercase letters. Changing this forces a new Workbook to be created.
    resourceGroupName string
    Specifies the name of the Resource Group where the Workbook should exist. Changing this forces a new Workbook to be created.
    sourceId string
    Resource ID for a source resource. It should not contain any uppercase letters. Defaults to azure monitor.
    storageContainerId string

    Specifies the Resource Manager ID of the Storage Container when bring your own storage is used. Changing this forces a new Workbook to be created.

    Note: This is the Resource Manager ID of the Storage Container, rather than the regular ID - and can be accessed on the azure.storage.Container Data Source/Resource as resource_manager_id.

    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Workbook.
    category str
    Workbook category, as defined by the user at creation time. There may be additional category types beyond the following: workbook, sentinel. Defaults to workbook.
    data_json str
    Configuration of this particular workbook. Configuration data is a string containing valid JSON.
    description str
    Specifies the description of the workbook.
    display_name str
    Specifies the user-defined name (display name) of the workbook.
    identity WorkbookIdentityArgs
    An identity block as defined below. Changing this forces a new Workbook to be created.
    location str
    Specifies the Azure Region where the Workbook should exist. Changing this forces a new Workbook to be created.
    name str
    Specifies the name of this Workbook as a UUID/GUID. It should not contain any uppercase letters. Changing this forces a new Workbook to be created.
    resource_group_name str
    Specifies the name of the Resource Group where the Workbook should exist. Changing this forces a new Workbook to be created.
    source_id str
    Resource ID for a source resource. It should not contain any uppercase letters. Defaults to azure monitor.
    storage_container_id str

    Specifies the Resource Manager ID of the Storage Container when bring your own storage is used. Changing this forces a new Workbook to be created.

    Note: This is the Resource Manager ID of the Storage Container, rather than the regular ID - and can be accessed on the azure.storage.Container Data Source/Resource as resource_manager_id.

    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Workbook.
    category String
    Workbook category, as defined by the user at creation time. There may be additional category types beyond the following: workbook, sentinel. Defaults to workbook.
    dataJson String
    Configuration of this particular workbook. Configuration data is a string containing valid JSON.
    description String
    Specifies the description of the workbook.
    displayName String
    Specifies the user-defined name (display name) of the workbook.
    identity Property Map
    An identity block as defined below. Changing this forces a new Workbook to be created.
    location String
    Specifies the Azure Region where the Workbook should exist. Changing this forces a new Workbook to be created.
    name String
    Specifies the name of this Workbook as a UUID/GUID. It should not contain any uppercase letters. Changing this forces a new Workbook to be created.
    resourceGroupName String
    Specifies the name of the Resource Group where the Workbook should exist. Changing this forces a new Workbook to be created.
    sourceId String
    Resource ID for a source resource. It should not contain any uppercase letters. Defaults to azure monitor.
    storageContainerId String

    Specifies the Resource Manager ID of the Storage Container when bring your own storage is used. Changing this forces a new Workbook to be created.

    Note: This is the Resource Manager ID of the Storage Container, rather than the regular ID - and can be accessed on the azure.storage.Container Data Source/Resource as resource_manager_id.

    tags Map<String>
    A mapping of tags which should be assigned to the Workbook.

    Supporting Types

    WorkbookIdentity, WorkbookIdentityArgs

    Type string
    The type of Managed Service Identity that is configured on this Workbook. Possible values are UserAssigned, SystemAssigned and SystemAssigned, UserAssigned. Changing this forces a new resource to be created.
    IdentityIds List<string>
    The list of User Assigned Managed Identity IDs assigned to this Workbook. Changing this forces a new resource to be created.
    PrincipalId string
    The Principal ID of the System Assigned Managed Service Identity that is configured on this Workbook.
    TenantId string
    The Tenant ID of the System Assigned Managed Service Identity that is configured on this Workbook.
    Type string
    The type of Managed Service Identity that is configured on this Workbook. Possible values are UserAssigned, SystemAssigned and SystemAssigned, UserAssigned. Changing this forces a new resource to be created.
    IdentityIds []string
    The list of User Assigned Managed Identity IDs assigned to this Workbook. Changing this forces a new resource to be created.
    PrincipalId string
    The Principal ID of the System Assigned Managed Service Identity that is configured on this Workbook.
    TenantId string
    The Tenant ID of the System Assigned Managed Service Identity that is configured on this Workbook.
    type String
    The type of Managed Service Identity that is configured on this Workbook. Possible values are UserAssigned, SystemAssigned and SystemAssigned, UserAssigned. Changing this forces a new resource to be created.
    identityIds List<String>
    The list of User Assigned Managed Identity IDs assigned to this Workbook. Changing this forces a new resource to be created.
    principalId String
    The Principal ID of the System Assigned Managed Service Identity that is configured on this Workbook.
    tenantId String
    The Tenant ID of the System Assigned Managed Service Identity that is configured on this Workbook.
    type string
    The type of Managed Service Identity that is configured on this Workbook. Possible values are UserAssigned, SystemAssigned and SystemAssigned, UserAssigned. Changing this forces a new resource to be created.
    identityIds string[]
    The list of User Assigned Managed Identity IDs assigned to this Workbook. Changing this forces a new resource to be created.
    principalId string
    The Principal ID of the System Assigned Managed Service Identity that is configured on this Workbook.
    tenantId string
    The Tenant ID of the System Assigned Managed Service Identity that is configured on this Workbook.
    type str
    The type of Managed Service Identity that is configured on this Workbook. Possible values are UserAssigned, SystemAssigned and SystemAssigned, UserAssigned. Changing this forces a new resource to be created.
    identity_ids Sequence[str]
    The list of User Assigned Managed Identity IDs assigned to this Workbook. Changing this forces a new resource to be created.
    principal_id str
    The Principal ID of the System Assigned Managed Service Identity that is configured on this Workbook.
    tenant_id str
    The Tenant ID of the System Assigned Managed Service Identity that is configured on this Workbook.
    type String
    The type of Managed Service Identity that is configured on this Workbook. Possible values are UserAssigned, SystemAssigned and SystemAssigned, UserAssigned. Changing this forces a new resource to be created.
    identityIds List<String>
    The list of User Assigned Managed Identity IDs assigned to this Workbook. Changing this forces a new resource to be created.
    principalId String
    The Principal ID of the System Assigned Managed Service Identity that is configured on this Workbook.
    tenantId String
    The Tenant ID of the System Assigned Managed Service Identity that is configured on this Workbook.

    Import

    Workbooks can be imported using the resource id, e.g.

    $ pulumi import azure:appinsights/workbook:Workbook example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Insights/workbooks/resource1

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.81.0 published on Monday, Jun 24, 2024 by Pulumi
    pulumi/pulumi-azure