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

We recommend using Azure Native.

Azure Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure

azure.appinsights.WorkbookTemplate

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.73.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure

    Manages an Application Insights Workbook Template.

    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 exampleWorkbookTemplate = new azure.appinsights.WorkbookTemplate("example", {
    name: "example-aiwt",
    resourceGroupName: example.name,
    location: "West Europe",
    author: "test author",
    priority: 1,
    galleries: [{
        category: "workbook",
        name: "test",
        order: 100,
        resourceType: "microsoft.insights/components",
        type: "tsg",
    }],
    templateData: JSON.stringify({
        version: "Notebook/1.0",
        items: [{
            type: 1,
            content: {
                json: `## New workbook
---

Welcome to your new workbook.`,
            },
            name: "text - 2",
        }],
        styleSettings: {},
        $schema: "https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json",
    }),
    localized: JSON.stringify({
        ar: [{
            galleries: [{
                name: "test",
                category: "Failures",
                type: "tsg",
                resourceType: "microsoft.insights/components",
                order: 100,
            }],
            templateData: {
                version: "Notebook/1.0",
                items: [{
                    type: 1,
                    content: {
                        json: `## New workbook
---

Welcome to your new workbook.`,
                    },
                    name: "text - 2",
                }],
                styleSettings: {},
                $schema: "https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json",
            },
        }],
    }),
    tags: {
        key: "value",
    },
});

    import pulumi
import json
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="West Europe")
example_workbook_template = azure.appinsights.WorkbookTemplate("example",
    name="example-aiwt",
    resource_group_name=example.name,
    location="West Europe",
    author="test author",
    priority=1,
    galleries=[azure.appinsights.WorkbookTemplateGalleryArgs(
        category="workbook",
        name="test",
        order=100,
        resource_type="microsoft.insights/components",
        type="tsg",
    )],
    template_data=json.dumps({
        "version": "Notebook/1.0",
        "items": [{
            "type": 1,
            "content": {
                "json": """## New workbook
---

Welcome to your new workbook.""",
            },
            "name": "text - 2",
        }],
        "styleSettings": {},
        "$schema": "https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json",
    }),
    localized=json.dumps({
        "ar": [{
            "galleries": [{
                "name": "test",
                "category": "Failures",
                "type": "tsg",
                "resourceType": "microsoft.insights/components",
                "order": 100,
            }],
            "templateData": {
                "version": "Notebook/1.0",
                "items": [{
                    "type": 1,
                    "content": {
                        "json": """## New workbook
---

Welcome to your new workbook.""",
                    },
                    "name": "text - 2",
                }],
                "styleSettings": {},
                "$schema": "https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json",
            },
        }],
    }),
    tags={
        "key": "value",
    })

    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": "## New workbook\n---\n\nWelcome to your new workbook.",
					},
					"name": "text - 2",
				},
			},
			"styleSettings": nil,
			"$schema":       "https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json",
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		tmpJSON1, err := json.Marshal(map[string]interface{}{
			"ar": []map[string]interface{}{
				map[string]interface{}{
					"galleries": []map[string]interface{}{
						map[string]interface{}{
							"name":         "test",
							"category":     "Failures",
							"type":         "tsg",
							"resourceType": "microsoft.insights/components",
							"order":        100,
						},
					},
					"templateData": map[string]interface{}{
						"version": "Notebook/1.0",
						"items": []map[string]interface{}{
							map[string]interface{}{
								"type": 1,
								"content": map[string]interface{}{
									"json": "## New workbook\n---\n\nWelcome to your new workbook.",
								},
								"name": "text - 2",
							},
						},
						"styleSettings": nil,
						"$schema":       "https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json",
					},
				},
			},
		})
		if err != nil {
			return err
		}
		json1 := string(tmpJSON1)
		_, err = appinsights.NewWorkbookTemplate(ctx, "example", &appinsights.WorkbookTemplateArgs{
			Name:              pulumi.String("example-aiwt"),
			ResourceGroupName: example.Name,
			Location:          pulumi.String("West Europe"),
			Author:            pulumi.String("test author"),
			Priority:          pulumi.Int(1),
			Galleries: appinsights.WorkbookTemplateGalleryArray{
				&appinsights.WorkbookTemplateGalleryArgs{
					Category:     pulumi.String("workbook"),
					Name:         pulumi.String("test"),
					Order:        pulumi.Int(100),
					ResourceType: pulumi.String("microsoft.insights/components"),
					Type:         pulumi.String("tsg"),
				},
			},
			TemplateData: pulumi.String(json0),
			Localized:    pulumi.String(json1),
			Tags: pulumi.StringMap{
				"key": pulumi.String("value"),
			},
		})
		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 exampleWorkbookTemplate = new Azure.AppInsights.WorkbookTemplate("example", new()
    {
        Name = "example-aiwt",
        ResourceGroupName = example.Name,
        Location = "West Europe",
        Author = "test author",
        Priority = 1,
        Galleries = new[]
        {
            new Azure.AppInsights.Inputs.WorkbookTemplateGalleryArgs
            {
                Category = "workbook",
                Name = "test",
                Order = 100,
                ResourceType = "microsoft.insights/components",
                Type = "tsg",
            },
        },
        TemplateData = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["version"] = "Notebook/1.0",
            ["items"] = new[]
            {
                new Dictionary<string, object?>
                {
                    ["type"] = 1,
                    ["content"] = new Dictionary<string, object?>
                    {
                        ["json"] = @"## New workbook
---

Welcome to your new workbook.",
                    },
                    ["name"] = "text - 2",
                },
            },
            ["styleSettings"] = new Dictionary<string, object?>
            {
            },
            ["$schema"] = "https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json",
        }),
        Localized = JsonSerializer.Serialize(new Dictionary<string, object?>
        {
            ["ar"] = new[]
            {
                new Dictionary<string, object?>
                {
                    ["galleries"] = new[]
                    {
                        new Dictionary<string, object?>
                        {
                            ["name"] = "test",
                            ["category"] = "Failures",
                            ["type"] = "tsg",
                            ["resourceType"] = "microsoft.insights/components",
                            ["order"] = 100,
                        },
                    },
                    ["templateData"] = new Dictionary<string, object?>
                    {
                        ["version"] = "Notebook/1.0",
                        ["items"] = new[]
                        {
                            new Dictionary<string, object?>
                            {
                                ["type"] = 1,
                                ["content"] = new Dictionary<string, object?>
                                {
                                    ["json"] = @"## New workbook
---

Welcome to your new workbook.",
                                },
                                ["name"] = "text - 2",
                            },
                        },
                        ["styleSettings"] = new Dictionary<string, object?>
                        {
                        },
                        ["$schema"] = "https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json",
                    },
                },
            },
        }),
        Tags = 
        {
            { "key", "value" },
        },
    });

});

    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.WorkbookTemplate;
import com.pulumi.azure.appinsights.WorkbookTemplateArgs;
import com.pulumi.azure.appinsights.inputs.WorkbookTemplateGalleryArgs;
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 exampleWorkbookTemplate = new WorkbookTemplate("exampleWorkbookTemplate", WorkbookTemplateArgs.builder()        
            .name("example-aiwt")
            .resourceGroupName(example.name())
            .location("West Europe")
            .author("test author")
            .priority(1)
            .galleries(WorkbookTemplateGalleryArgs.builder()
                .category("workbook")
                .name("test")
                .order(100)
                .resourceType("microsoft.insights/components")
                .type("tsg")
                .build())
            .templateData(serializeJson(
                jsonObject(
                    jsonProperty("version", "Notebook/1.0"),
                    jsonProperty("items", jsonArray(jsonObject(
                        jsonProperty("type", 1),
                        jsonProperty("content", jsonObject(
                            jsonProperty("json", """
## New workbook
---

Welcome to your new workbook.                            """)
                        )),
                        jsonProperty("name", "text - 2")
                    ))),
                    jsonProperty("styleSettings", jsonObject(

                    )),
                    jsonProperty("$schema", "https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json")
                )))
            .localized(serializeJson(
                jsonObject(
                    jsonProperty("ar", jsonArray(jsonObject(
                        jsonProperty("galleries", jsonArray(jsonObject(
                            jsonProperty("name", "test"),
                            jsonProperty("category", "Failures"),
                            jsonProperty("type", "tsg"),
                            jsonProperty("resourceType", "microsoft.insights/components"),
                            jsonProperty("order", 100)
                        ))),
                        jsonProperty("templateData", jsonObject(
                            jsonProperty("version", "Notebook/1.0"),
                            jsonProperty("items", jsonArray(jsonObject(
                                jsonProperty("type", 1),
                                jsonProperty("content", jsonObject(
                                    jsonProperty("json", """
## New workbook
---

Welcome to your new workbook.                                    """)
                                )),
                                jsonProperty("name", "text - 2")
                            ))),
                            jsonProperty("styleSettings", jsonObject(

                            )),
                            jsonProperty("$schema", "https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json")
                        ))
                    )))
                )))
            .tags(Map.of("key", "value"))
            .build());

    }
}

    resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  exampleWorkbookTemplate:
    type: azure:appinsights:WorkbookTemplate
    name: example
    properties:
      name: example-aiwt
      resourceGroupName: ${example.name}
      location: West Europe
      author: test author
      priority: 1
      galleries:
        - category: workbook
          name: test
          order: 100
          resourceType: microsoft.insights/components
          type: tsg
      templateData:
        fn::toJSON:
          version: Notebook/1.0
          items:
            - type: 1
              content:
                json: |-
                  ## New workbook
                  ---

                  Welcome to your new workbook.                  
              name: text - 2
          styleSettings: {}
          $schema: https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json
      localized:
        fn::toJSON:
          ar:
            - galleries:
                - name: test
                  category: Failures
                  type: tsg
                  resourceType: microsoft.insights/components
                  order: 100
              templateData:
                version: Notebook/1.0
                items:
                  - type: 1
                    content:
                      json: |-
                        ## New workbook
                        ---

                        Welcome to your new workbook.                        
                    name: text - 2
                styleSettings: {}
                $schema: https://github.com/Microsoft/Application-Insights-Workbooks/blob/master/schema/workbook.json
      tags:
        key: value

    Create WorkbookTemplate Resource

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

    Constructor syntax

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

@overload
def WorkbookTemplate(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     galleries: Optional[Sequence[WorkbookTemplateGalleryArgs]] = None,
                     resource_group_name: Optional[str] = None,
                     template_data: Optional[str] = None,
                     author: Optional[str] = None,
                     localized: Optional[str] = None,
                     location: Optional[str] = None,
                     name: Optional[str] = None,
                     priority: Optional[int] = None,
                     tags: Optional[Mapping[str, str]] = None)
    func NewWorkbookTemplate(ctx *Context, name string, args WorkbookTemplateArgs, opts ...ResourceOption) (*WorkbookTemplate, error)
    public WorkbookTemplate(string name, WorkbookTemplateArgs args, CustomResourceOptions? opts = null)
    public WorkbookTemplate(String name, WorkbookTemplateArgs args)
public WorkbookTemplate(String name, WorkbookTemplateArgs args, CustomResourceOptions options)

    type: azure:appinsights:WorkbookTemplate
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 WorkbookTemplateArgs
    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 WorkbookTemplateArgs
    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 WorkbookTemplateArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args WorkbookTemplateArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args WorkbookTemplateArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var workbookTemplateResource = new Azure.AppInsights.WorkbookTemplate("workbookTemplateResource", new()
{
    Galleries = new[]
    {
        new Azure.AppInsights.Inputs.WorkbookTemplateGalleryArgs
        {
            Category = "string",
            Name = "string",
            Order = 0,
            ResourceType = "string",
            Type = "string",
        },
    },
    ResourceGroupName = "string",
    TemplateData = "string",
    Author = "string",
    Localized = "string",
    Location = "string",
    Name = "string",
    Priority = 0,
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := appinsights.NewWorkbookTemplate(ctx, "workbookTemplateResource", &appinsights.WorkbookTemplateArgs{
	Galleries: appinsights.WorkbookTemplateGalleryArray{
		&appinsights.WorkbookTemplateGalleryArgs{
			Category:     pulumi.String("string"),
			Name:         pulumi.String("string"),
			Order:        pulumi.Int(0),
			ResourceType: pulumi.String("string"),
			Type:         pulumi.String("string"),
		},
	},
	ResourceGroupName: pulumi.String("string"),
	TemplateData:      pulumi.String("string"),
	Author:            pulumi.String("string"),
	Localized:         pulumi.String("string"),
	Location:          pulumi.String("string"),
	Name:              pulumi.String("string"),
	Priority:          pulumi.Int(0),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var workbookTemplateResource = new WorkbookTemplate("workbookTemplateResource", WorkbookTemplateArgs.builder()        
    .galleries(WorkbookTemplateGalleryArgs.builder()
        .category("string")
        .name("string")
        .order(0)
        .resourceType("string")
        .type("string")
        .build())
    .resourceGroupName("string")
    .templateData("string")
    .author("string")
    .localized("string")
    .location("string")
    .name("string")
    .priority(0)
    .tags(Map.of("string", "string"))
    .build());

    workbook_template_resource = azure.appinsights.WorkbookTemplate("workbookTemplateResource",
    galleries=[azure.appinsights.WorkbookTemplateGalleryArgs(
        category="string",
        name="string",
        order=0,
        resource_type="string",
        type="string",
    )],
    resource_group_name="string",
    template_data="string",
    author="string",
    localized="string",
    location="string",
    name="string",
    priority=0,
    tags={
        "string": "string",
    })

    const workbookTemplateResource = new azure.appinsights.WorkbookTemplate("workbookTemplateResource", {
    galleries: [{
        category: "string",
        name: "string",
        order: 0,
        resourceType: "string",
        type: "string",
    }],
    resourceGroupName: "string",
    templateData: "string",
    author: "string",
    localized: "string",
    location: "string",
    name: "string",
    priority: 0,
    tags: {
        string: "string",
    },
});

    type: azure:appinsights:WorkbookTemplate
properties:
    author: string
    galleries:
        - category: string
          name: string
          order: 0
          resourceType: string
          type: string
    localized: string
    location: string
    name: string
    priority: 0
    resourceGroupName: string
    tags:
        string: string
    templateData: string

    WorkbookTemplate 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 WorkbookTemplate resource accepts the following input properties:

    Galleries List<WorkbookTemplateGallery>
    A galleries block as defined below.
    ResourceGroupName string
    Specifies the name of the Resource Group where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    TemplateData string
    Valid JSON object containing workbook template payload.
    Author string
    Information about the author of the workbook template.
    Localized string
    Key value pairs of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    Location string
    Specifies the Azure Region where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    Name string
    Specifies the name which should be used for this Application Insights Workbook Template. Changing this forces a new Application Insights Workbook Template to be created.
    Priority int
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode. Defaults to 0.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Application Insights Workbook Template.
    Galleries []WorkbookTemplateGalleryArgs
    A galleries block as defined below.
    ResourceGroupName string
    Specifies the name of the Resource Group where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    TemplateData string
    Valid JSON object containing workbook template payload.
    Author string
    Information about the author of the workbook template.
    Localized string
    Key value pairs of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    Location string
    Specifies the Azure Region where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    Name string
    Specifies the name which should be used for this Application Insights Workbook Template. Changing this forces a new Application Insights Workbook Template to be created.
    Priority int
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode. Defaults to 0.
    Tags map[string]string
    A mapping of tags which should be assigned to the Application Insights Workbook Template.
    galleries List<WorkbookTemplateGallery>
    A galleries block as defined below.
    resourceGroupName String
    Specifies the name of the Resource Group where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    templateData String
    Valid JSON object containing workbook template payload.
    author String
    Information about the author of the workbook template.
    localized String
    Key value pairs of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    location String
    Specifies the Azure Region where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    name String
    Specifies the name which should be used for this Application Insights Workbook Template. Changing this forces a new Application Insights Workbook Template to be created.
    priority Integer
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode. Defaults to 0.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Application Insights Workbook Template.
    galleries WorkbookTemplateGallery[]
    A galleries block as defined below.
    resourceGroupName string
    Specifies the name of the Resource Group where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    templateData string
    Valid JSON object containing workbook template payload.
    author string
    Information about the author of the workbook template.
    localized string
    Key value pairs of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    location string
    Specifies the Azure Region where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    name string
    Specifies the name which should be used for this Application Insights Workbook Template. Changing this forces a new Application Insights Workbook Template to be created.
    priority number
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode. Defaults to 0.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Application Insights Workbook Template.
    galleries Sequence[WorkbookTemplateGalleryArgs]
    A galleries block as defined below.
    resource_group_name str
    Specifies the name of the Resource Group where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    template_data str
    Valid JSON object containing workbook template payload.
    author str
    Information about the author of the workbook template.
    localized str
    Key value pairs of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    location str
    Specifies the Azure Region where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    name str
    Specifies the name which should be used for this Application Insights Workbook Template. Changing this forces a new Application Insights Workbook Template to be created.
    priority int
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode. Defaults to 0.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Application Insights Workbook Template.
    galleries List<Property Map>
    A galleries block as defined below.
    resourceGroupName String
    Specifies the name of the Resource Group where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    templateData String
    Valid JSON object containing workbook template payload.
    author String
    Information about the author of the workbook template.
    localized String
    Key value pairs of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    location String
    Specifies the Azure Region where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    name String
    Specifies the name which should be used for this Application Insights Workbook Template. Changing this forces a new Application Insights Workbook Template to be created.
    priority Number
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode. Defaults to 0.
    tags Map<String>
    A mapping of tags which should be assigned to the Application Insights Workbook Template.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the WorkbookTemplate 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 WorkbookTemplate Resource

    Get an existing WorkbookTemplate 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?: WorkbookTemplateState, opts?: CustomResourceOptions): WorkbookTemplate
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        author: Optional[str] = None,
        galleries: Optional[Sequence[WorkbookTemplateGalleryArgs]] = None,
        localized: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        priority: Optional[int] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        template_data: Optional[str] = None) -> WorkbookTemplate
    func GetWorkbookTemplate(ctx *Context, name string, id IDInput, state *WorkbookTemplateState, opts ...ResourceOption) (*WorkbookTemplate, error)
    public static WorkbookTemplate Get(string name, Input<string> id, WorkbookTemplateState? state, CustomResourceOptions? opts = null)
    public static WorkbookTemplate get(String name, Output<String> id, WorkbookTemplateState 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:
    Author string
    Information about the author of the workbook template.
    Galleries List<WorkbookTemplateGallery>
    A galleries block as defined below.
    Localized string
    Key value pairs of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    Location string
    Specifies the Azure Region where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    Name string
    Specifies the name which should be used for this Application Insights Workbook Template. Changing this forces a new Application Insights Workbook Template to be created.
    Priority int
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode. Defaults to 0.
    ResourceGroupName string
    Specifies the name of the Resource Group where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    Tags Dictionary<string, string>
    A mapping of tags which should be assigned to the Application Insights Workbook Template.
    TemplateData string
    Valid JSON object containing workbook template payload.
    Author string
    Information about the author of the workbook template.
    Galleries []WorkbookTemplateGalleryArgs
    A galleries block as defined below.
    Localized string
    Key value pairs of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    Location string
    Specifies the Azure Region where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    Name string
    Specifies the name which should be used for this Application Insights Workbook Template. Changing this forces a new Application Insights Workbook Template to be created.
    Priority int
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode. Defaults to 0.
    ResourceGroupName string
    Specifies the name of the Resource Group where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    Tags map[string]string
    A mapping of tags which should be assigned to the Application Insights Workbook Template.
    TemplateData string
    Valid JSON object containing workbook template payload.
    author String
    Information about the author of the workbook template.
    galleries List<WorkbookTemplateGallery>
    A galleries block as defined below.
    localized String
    Key value pairs of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    location String
    Specifies the Azure Region where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    name String
    Specifies the name which should be used for this Application Insights Workbook Template. Changing this forces a new Application Insights Workbook Template to be created.
    priority Integer
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode. Defaults to 0.
    resourceGroupName String
    Specifies the name of the Resource Group where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    tags Map<String,String>
    A mapping of tags which should be assigned to the Application Insights Workbook Template.
    templateData String
    Valid JSON object containing workbook template payload.
    author string
    Information about the author of the workbook template.
    galleries WorkbookTemplateGallery[]
    A galleries block as defined below.
    localized string
    Key value pairs of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    location string
    Specifies the Azure Region where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    name string
    Specifies the name which should be used for this Application Insights Workbook Template. Changing this forces a new Application Insights Workbook Template to be created.
    priority number
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode. Defaults to 0.
    resourceGroupName string
    Specifies the name of the Resource Group where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    tags {[key: string]: string}
    A mapping of tags which should be assigned to the Application Insights Workbook Template.
    templateData string
    Valid JSON object containing workbook template payload.
    author str
    Information about the author of the workbook template.
    galleries Sequence[WorkbookTemplateGalleryArgs]
    A galleries block as defined below.
    localized str
    Key value pairs of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    location str
    Specifies the Azure Region where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    name str
    Specifies the name which should be used for this Application Insights Workbook Template. Changing this forces a new Application Insights Workbook Template to be created.
    priority int
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode. Defaults to 0.
    resource_group_name str
    Specifies the name of the Resource Group where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    tags Mapping[str, str]
    A mapping of tags which should be assigned to the Application Insights Workbook Template.
    template_data str
    Valid JSON object containing workbook template payload.
    author String
    Information about the author of the workbook template.
    galleries List<Property Map>
    A galleries block as defined below.
    localized String
    Key value pairs of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    location String
    Specifies the Azure Region where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    name String
    Specifies the name which should be used for this Application Insights Workbook Template. Changing this forces a new Application Insights Workbook Template to be created.
    priority Number
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode. Defaults to 0.
    resourceGroupName String
    Specifies the name of the Resource Group where the Application Insights Workbook Template should exist. Changing this forces a new Application Insights Workbook Template to be created.
    tags Map<String>
    A mapping of tags which should be assigned to the Application Insights Workbook Template.
    templateData String
    Valid JSON object containing workbook template payload.

    Supporting Types

    WorkbookTemplateGallery, WorkbookTemplateGalleryArgs

    Category string
    Category for the gallery.
    Name string
    Name of the workbook template in the gallery.
    Order int
    Order of the template within the gallery. Defaults to 0.
    ResourceType string
    Azure resource type supported by the gallery. Defaults to Azure Monitor.
    Type string

    Type of workbook supported by the workbook template. Defaults to workbook.

    Note: See documentation for more information of resource_type and type.

    Category string
    Category for the gallery.
    Name string
    Name of the workbook template in the gallery.
    Order int
    Order of the template within the gallery. Defaults to 0.
    ResourceType string
    Azure resource type supported by the gallery. Defaults to Azure Monitor.
    Type string

    Type of workbook supported by the workbook template. Defaults to workbook.

    Note: See documentation for more information of resource_type and type.

    category String
    Category for the gallery.
    name String
    Name of the workbook template in the gallery.
    order Integer
    Order of the template within the gallery. Defaults to 0.
    resourceType String
    Azure resource type supported by the gallery. Defaults to Azure Monitor.
    type String

    Type of workbook supported by the workbook template. Defaults to workbook.

    Note: See documentation for more information of resource_type and type.

    category string
    Category for the gallery.
    name string
    Name of the workbook template in the gallery.
    order number
    Order of the template within the gallery. Defaults to 0.
    resourceType string
    Azure resource type supported by the gallery. Defaults to Azure Monitor.
    type string

    Type of workbook supported by the workbook template. Defaults to workbook.

    Note: See documentation for more information of resource_type and type.

    category str
    Category for the gallery.
    name str
    Name of the workbook template in the gallery.
    order int
    Order of the template within the gallery. Defaults to 0.
    resource_type str
    Azure resource type supported by the gallery. Defaults to Azure Monitor.
    type str

    Type of workbook supported by the workbook template. Defaults to workbook.

    Note: See documentation for more information of resource_type and type.

    category String
    Category for the gallery.
    name String
    Name of the workbook template in the gallery.
    order Number
    Order of the template within the gallery. Defaults to 0.
    resourceType String
    Azure resource type supported by the gallery. Defaults to Azure Monitor.
    type String

    Type of workbook supported by the workbook template. Defaults to workbook.

    Note: See documentation for more information of resource_type and type.

    Import

    Application Insights Workbook Template can be imported using the resource id, e.g.

    $ pulumi import azure:appinsights/workbookTemplate:WorkbookTemplate example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Insights/workbookTemplates/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.73.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-azure