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

Azure Native

v1.41.0 published on Wednesday, Oct 20, 2021 by Pulumi

WorkbookTemplate

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

Example Usage

WorkbookTemplateAdd

using Pulumi;
using AzureNative = Pulumi.AzureNative;

class MyStack : Stack
{
    public MyStack()
    {
        var workbookTemplate = new AzureNative.Insights.WorkbookTemplate("workbookTemplate", new AzureNative.Insights.WorkbookTemplateArgs
        {
            Author = "Contoso",
            Galleries = 
            {
                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 = ,
        });
    }

}

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := insights.NewWorkbookTemplate(ctx, "workbookTemplate", &insights.WorkbookTemplateArgs{
			Author: pulumi.String("Contoso"),
			Galleries: insights.WorkbookTemplateGalleryArray{
				&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
	})
}

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: {},
});

Create a WorkbookTemplate Resource

new WorkbookTemplate(name: string, args: WorkbookTemplateArgs, opts?: CustomResourceOptions);
@overload
def WorkbookTemplate(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     author: Optional[str] = None,
                     galleries: Optional[Sequence[WorkbookTemplateGalleryArgs]] = None,
                     localized: Optional[Mapping[str, Sequence[WorkbookTemplateLocalizedGalleryArgs]]] = None,
                     location: Optional[str] = None,
                     priority: Optional[int] = None,
                     resource_group_name: Optional[str] = None,
                     resource_name_: Optional[str] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     template_data: Optional[Any] = None)
@overload
def WorkbookTemplate(resource_name: str,
                     args: WorkbookTemplateArgs,
                     opts: Optional[ResourceOptions] = None)
func NewWorkbookTemplate(ctx *Context, name string, args WorkbookTemplateArgs, opts ...ResourceOption) (*WorkbookTemplate, error)
public WorkbookTemplate(string name, WorkbookTemplateArgs args, CustomResourceOptions? opts = null)
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.

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<Pulumi.AzureNative.Insights.Inputs.WorkbookTemplateGalleryArgs>
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 WorkbookTemplateGalleryArgs[]
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

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 str
The provider-assigned unique ID for this managed resource.
name str
Azure resource name.
type str
Azure resource type

Supporting Types

WorkbookTemplateGallery

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 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.

WorkbookTemplateGalleryResponse

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 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.

WorkbookTemplateLocalizedGallery

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 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.

WorkbookTemplateLocalizedGalleryResponse

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 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.

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 

Package Details

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