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

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi

azure.appinsights.Workbook

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.49.0 published on Tuesday, Aug 29, 2023 by Pulumi

    Manages an Azure Workbook.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using System.Text.Json;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
        {
            Location = "West Europe",
        });
    
        var exampleWorkbook = new Azure.AppInsights.Workbook("exampleWorkbook", new()
        {
            ResourceGroupName = exampleResourceGroup.Name,
            Location = exampleResourceGroup.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 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 {
    		exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
    			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, "exampleWorkbook", &appinsights.WorkbookArgs{
    			ResourceGroupName: exampleResourceGroup.Name,
    			Location:          exampleResourceGroup.Location,
    			DisplayName:       pulumi.String("workbook1"),
    			DataJson:          pulumi.String(json0),
    			Tags: pulumi.StringMap{
    				"ENV": pulumi.String("Test"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()        
                .location("West Europe")
                .build());
    
            var exampleWorkbook = new Workbook("exampleWorkbook", WorkbookArgs.builder()        
                .resourceGroupName(exampleResourceGroup.name())
                .location(exampleResourceGroup.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());
    
        }
    }
    
    import pulumi
    import json
    import pulumi_azure as azure
    
    example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
    example_workbook = azure.appinsights.Workbook("exampleWorkbook",
        resource_group_name=example_resource_group.name,
        location=example_resource_group.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",
        })
    
    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
    const exampleWorkbook = new azure.appinsights.Workbook("exampleWorkbook", {
        resourceGroupName: exampleResourceGroup.name,
        location: exampleResourceGroup.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",
        },
    });
    
    resources:
      exampleResourceGroup:
        type: azure:core:ResourceGroup
        properties:
          location: West Europe
      exampleWorkbook:
        type: azure:appinsights:Workbook
        properties:
          resourceGroupName: ${exampleResourceGroup.name}
          location: ${exampleResourceGroup.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

    new Workbook(name: string, args: WorkbookArgs, opts?: CustomResourceOptions);
    @overload
    def Workbook(resource_name: 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)
    @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)
    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.
    
    
    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.

    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
    

    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.49.0 published on Tuesday, Aug 29, 2023 by Pulumi