Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. insights
  5. WorkbookTemplate
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.insights.WorkbookTemplate

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    An Application Insights workbook template definition. API Version: 2019-10-17-preview.

    Example Usage

    WorkbookTemplateAdd

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var workbookTemplate = new AzureNative.Insights.WorkbookTemplate("workbookTemplate", new()
    {
        Author = "Contoso",
        Galleries = new[]
        {
            new AzureNative.Insights.Inputs.WorkbookTemplateGalleryArgs
            {
                Category = "Failures",
                Name = "Simple Template",
                Order = 100,
                ResourceType = "microsoft.insights/components",
                Type = "tsg",
            },
        },
        Location = "west us",
        Priority = 1,
        ResourceGroupName = "my-resource-group",
        ResourceName = "testtemplate2",
        TemplateData = null,
    });

});

    package main

import (
	insights "github.com/pulumi/pulumi-azure-native-sdk/insights"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := insights.NewWorkbookTemplate(ctx, "workbookTemplate", &insights.WorkbookTemplateArgs{
			Author: pulumi.String("Contoso"),
			Galleries: []insights.WorkbookTemplateGalleryArgs{
				{
					Category:     pulumi.String("Failures"),
					Name:         pulumi.String("Simple Template"),
					Order:        pulumi.Int(100),
					ResourceType: pulumi.String("microsoft.insights/components"),
					Type:         pulumi.String("tsg"),
				},
			},
			Location:          pulumi.String("west us"),
			Priority:          pulumi.Int(1),
			ResourceGroupName: pulumi.String("my-resource-group"),
			ResourceName:      pulumi.String("testtemplate2"),
			TemplateData:      nil,
		})
		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.azurenative.insights.WorkbookTemplate;
import com.pulumi.azurenative.insights.WorkbookTemplateArgs;
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 workbookTemplate = new WorkbookTemplate("workbookTemplate", WorkbookTemplateArgs.builder()        
            .author("Contoso")
            .galleries(Map.ofEntries(
                Map.entry("category", "Failures"),
                Map.entry("name", "Simple Template"),
                Map.entry("order", 100),
                Map.entry("resourceType", "microsoft.insights/components"),
                Map.entry("type", "tsg")
            ))
            .location("west us")
            .priority(1)
            .resourceGroupName("my-resource-group")
            .resourceName("testtemplate2")
            .templateData()
            .build());

    }
}

    import pulumi
import pulumi_azure_native as azure_native

workbook_template = azure_native.insights.WorkbookTemplate("workbookTemplate",
    author="Contoso",
    galleries=[azure_native.insights.WorkbookTemplateGalleryArgs(
        category="Failures",
        name="Simple Template",
        order=100,
        resource_type="microsoft.insights/components",
        type="tsg",
    )],
    location="west us",
    priority=1,
    resource_group_name="my-resource-group",
    resource_name_="testtemplate2",
    template_data={})

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

const workbookTemplate = new azure_native.insights.WorkbookTemplate("workbookTemplate", {
    author: "Contoso",
    galleries: [{
        category: "Failures",
        name: "Simple Template",
        order: 100,
        resourceType: "microsoft.insights/components",
        type: "tsg",
    }],
    location: "west us",
    priority: 1,
    resourceGroupName: "my-resource-group",
    resourceName: "testtemplate2",
    templateData: {},
});

    resources:
  workbookTemplate:
    type: azure-native:insights:WorkbookTemplate
    properties:
      author: Contoso
      galleries:
        - category: Failures
          name: Simple Template
          order: 100
          resourceType: microsoft.insights/components
          type: tsg
      location: west us
      priority: 1
      resourceGroupName: my-resource-group
      resourceName: testtemplate2
      templateData: {}

    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[Any] = None,
                     author: Optional[str] = None,
                     localized: Optional[Mapping[str, Sequence[WorkbookTemplateLocalizedGalleryArgs]]] = None,
                     location: Optional[str] = None,
                     priority: Optional[int] = None,
                     resource_name_: Optional[str] = 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-native:insights: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.

    Constructor example

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

    var workbookTemplateResource = new AzureNative.Insights.WorkbookTemplate("workbookTemplateResource", new()
{
    Galleries = new[]
    {
        
        {
            { "category", "string" },
            { "name", "string" },
            { "order", 0 },
            { "resourceType", "string" },
            { "type", "string" },
        },
    },
    ResourceGroupName = "string",
    TemplateData = "any",
    Author = "string",
    Localized = 
    {
        { "string", new[]
        {
            
            {
                { "galleries", new[]
                {
                    
                    {
                        { "category", "string" },
                        { "name", "string" },
                        { "order", 0 },
                        { "resourceType", "string" },
                        { "type", "string" },
                    },
                } },
                { "templateData", "any" },
            },
        } },
    },
    Location = "string",
    Priority = 0,
    ResourceName = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := insights.NewWorkbookTemplate(ctx, "workbookTemplateResource", &insights.WorkbookTemplateArgs{
	Galleries: []map[string]interface{}{
		map[string]interface{}{
			"category":     "string",
			"name":         "string",
			"order":        0,
			"resourceType": "string",
			"type":         "string",
		},
	},
	ResourceGroupName: "string",
	TemplateData:      "any",
	Author:            "string",
	Localized: map[string]interface{}{
		"string": []map[string]interface{}{
			map[string]interface{}{
				"galleries": []map[string]interface{}{
					map[string]interface{}{
						"category":     "string",
						"name":         "string",
						"order":        0,
						"resourceType": "string",
						"type":         "string",
					},
				},
				"templateData": "any",
			},
		},
	},
	Location:     "string",
	Priority:     0,
	ResourceName: "string",
	Tags: map[string]interface{}{
		"string": "string",
	},
})

    var workbookTemplateResource = new WorkbookTemplate("workbookTemplateResource", WorkbookTemplateArgs.builder()
    .galleries(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .resourceGroupName("string")
    .templateData("any")
    .author("string")
    .localized(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .location("string")
    .priority(0)
    .resourceName("string")
    .tags(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .build());

    workbook_template_resource = azure_native.insights.WorkbookTemplate("workbookTemplateResource",
    galleries=[{
        category: string,
        name: string,
        order: 0,
        resourceType: string,
        type: string,
    }],
    resource_group_name=string,
    template_data=any,
    author=string,
    localized={
        string: [{
            galleries: [{
                category: string,
                name: string,
                order: 0,
                resourceType: string,
                type: string,
            }],
            templateData: any,
        }],
    },
    location=string,
    priority=0,
    resource_name_=string,
    tags={
        string: string,
    })

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

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

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The WorkbookTemplate resource accepts the following input properties:

    Galleries List<Pulumi.AzureNative.Insights.Inputs.WorkbookTemplateGallery>
    Workbook galleries supported by the template.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    TemplateData object
    Valid JSON object containing workbook template payload.
    Author string
    Information about the author of the workbook template.
    Localized Dictionary<string, ImmutableArray<Pulumi.AzureNative.Insights.Inputs.WorkbookTemplateLocalizedGalleryArgs>>
    Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    Location string
    Resource location
    Priority int
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode.
    ResourceName string
    The name of the Application Insights component resource.
    Tags Dictionary<string, string>
    Resource tags
    Galleries []WorkbookTemplateGalleryArgs
    Workbook galleries supported by the template.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    TemplateData interface{}
    Valid JSON object containing workbook template payload.
    Author string
    Information about the author of the workbook template.
    Localized map[string][]WorkbookTemplateLocalizedGalleryArgs
    Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    Location string
    Resource location
    Priority int
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode.
    ResourceName string
    The name of the Application Insights component resource.
    Tags map[string]string
    Resource tags
    galleries List<WorkbookTemplateGallery>
    Workbook galleries supported by the template.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    templateData Object
    Valid JSON object containing workbook template payload.
    author String
    Information about the author of the workbook template.
    localized Map<String,List<WorkbookTemplateLocalizedGalleryArgs>>
    Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    location String
    Resource location
    priority Integer
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode.
    resourceName String
    The name of the Application Insights component resource.
    tags Map<String,String>
    Resource tags
    galleries WorkbookTemplateGallery[]
    Workbook galleries supported by the template.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    templateData any
    Valid JSON object containing workbook template payload.
    author string
    Information about the author of the workbook template.
    localized {[key: string]: WorkbookTemplateLocalizedGalleryArgs[]}
    Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    location string
    Resource location
    priority number
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode.
    resourceName string
    The name of the Application Insights component resource.
    tags {[key: string]: string}
    Resource tags
    galleries Sequence[WorkbookTemplateGalleryArgs]
    Workbook galleries supported by the template.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    template_data Any
    Valid JSON object containing workbook template payload.
    author str
    Information about the author of the workbook template.
    localized Mapping[str, Sequence[WorkbookTemplateLocalizedGalleryArgs]]
    Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    location str
    Resource location
    priority int
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode.
    resource_name str
    The name of the Application Insights component resource.
    tags Mapping[str, str]
    Resource tags
    galleries List<Property Map>
    Workbook galleries supported by the template.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    templateData Any
    Valid JSON object containing workbook template payload.
    author String
    Information about the author of the workbook template.
    localized Map<List<Property Map>>
    Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal.
    location String
    Resource location
    priority Number
    Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode.
    resourceName String
    The name of the Application Insights component resource.
    tags Map<String>
    Resource tags

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

    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.
    ResourceType string
    Azure resource type supported by the gallery.
    Type string
    Type of workbook supported by the workbook template.
    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.
    ResourceType string
    Azure resource type supported by the gallery.
    Type string
    Type of workbook supported by the workbook template.
    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.
    resourceType String
    Azure resource type supported by the gallery.
    type String
    Type of workbook supported by the workbook template.
    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.
    resourceType string
    Azure resource type supported by the gallery.
    type string
    Type of workbook supported by the workbook template.
    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.
    resource_type str
    Azure resource type supported by the gallery.
    type str
    Type of workbook supported by the workbook template.
    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.
    resourceType String
    Azure resource type supported by the gallery.
    type String
    Type of workbook supported by the workbook template.

    WorkbookTemplateGalleryResponse, WorkbookTemplateGalleryResponseArgs

    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.
    ResourceType string
    Azure resource type supported by the gallery.
    Type string
    Type of workbook supported by the workbook template.
    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.
    ResourceType string
    Azure resource type supported by the gallery.
    Type string
    Type of workbook supported by the workbook template.
    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.
    resourceType String
    Azure resource type supported by the gallery.
    type String
    Type of workbook supported by the workbook template.
    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.
    resourceType string
    Azure resource type supported by the gallery.
    type string
    Type of workbook supported by the workbook template.
    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.
    resource_type str
    Azure resource type supported by the gallery.
    type str
    Type of workbook supported by the workbook template.
    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.
    resourceType String
    Azure resource type supported by the gallery.
    type String
    Type of workbook supported by the workbook template.

    WorkbookTemplateLocalizedGallery, WorkbookTemplateLocalizedGalleryArgs

    Galleries List<Pulumi.AzureNative.Insights.Inputs.WorkbookTemplateGallery>
    Workbook galleries supported by the template.
    TemplateData object
    Valid JSON object containing workbook template payload.
    Galleries []WorkbookTemplateGallery
    Workbook galleries supported by the template.
    TemplateData interface{}
    Valid JSON object containing workbook template payload.
    galleries List<WorkbookTemplateGallery>
    Workbook galleries supported by the template.
    templateData Object
    Valid JSON object containing workbook template payload.
    galleries WorkbookTemplateGallery[]
    Workbook galleries supported by the template.
    templateData any
    Valid JSON object containing workbook template payload.
    galleries Sequence[WorkbookTemplateGallery]
    Workbook galleries supported by the template.
    template_data Any
    Valid JSON object containing workbook template payload.
    galleries List<Property Map>
    Workbook galleries supported by the template.
    templateData Any
    Valid JSON object containing workbook template payload.

    WorkbookTemplateLocalizedGalleryResponse, WorkbookTemplateLocalizedGalleryResponseArgs

    Galleries List<Pulumi.AzureNative.Insights.Inputs.WorkbookTemplateGalleryResponse>
    Workbook galleries supported by the template.
    TemplateData object
    Valid JSON object containing workbook template payload.
    Galleries []WorkbookTemplateGalleryResponse
    Workbook galleries supported by the template.
    TemplateData interface{}
    Valid JSON object containing workbook template payload.
    galleries List<WorkbookTemplateGalleryResponse>
    Workbook galleries supported by the template.
    templateData Object
    Valid JSON object containing workbook template payload.
    galleries WorkbookTemplateGalleryResponse[]
    Workbook galleries supported by the template.
    templateData any
    Valid JSON object containing workbook template payload.
    galleries Sequence[WorkbookTemplateGalleryResponse]
    Workbook galleries supported by the template.
    template_data Any
    Valid JSON object containing workbook template payload.
    galleries List<Property Map>
    Workbook galleries supported by the template.
    templateData Any
    Valid JSON object containing workbook template payload.

    Import

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

    $ pulumi import azure-native:insights:WorkbookTemplate testtemplate2 /subscriptions/50359d91-7b9d-4823-85af-eb298a61ba95/resourceGroups/testrg/providers/microsoft.insights/workbooktemplates/testtemplate2

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

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native