1. Packages
  2. Azure Native
  3. API Docs
  4. applicationinsights
  5. Workbook
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

azure-native.applicationinsights.Workbook

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi

A workbook definition.

Uses Azure REST API version 2023-06-01.

Other available API versions: 2015-05-01, 2018-06-17-preview, 2020-10-20, 2021-03-08, 2021-08-01, 2022-04-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native applicationinsights [ApiVersion]. See the version guide for details.

Example Usage

WorkbookAdd

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

return await Deployment.RunAsync(() => 
{
    var workbook = new AzureNative.ApplicationInsights.Workbook("workbook", new()
    {
        Category = "workbook",
        Description = "Sample workbook",
        DisplayName = "Sample workbook",
        Kind = AzureNative.ApplicationInsights.WorkbookSharedTypeKind.Shared,
        Location = "westus",
        ResourceGroupName = "my-resource-group",
        ResourceName = "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2",
        SerializedData = "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook.  This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}",
        SourceId = "/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourcegroups/my-resource-group",
        Tags = 
        {
            { "TagSample01", "sample01" },
            { "TagSample02", "sample02" },
        },
    });

});
Copy
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := applicationinsights.NewWorkbook(ctx, "workbook", &applicationinsights.WorkbookArgs{
			Category:          pulumi.String("workbook"),
			Description:       pulumi.String("Sample workbook"),
			DisplayName:       pulumi.String("Sample workbook"),
			Kind:              pulumi.String(applicationinsights.WorkbookSharedTypeKindShared),
			Location:          pulumi.String("westus"),
			ResourceGroupName: pulumi.String("my-resource-group"),
			ResourceName:      pulumi.String("deadb33f-5e0d-4064-8ebb-1a4ed0313eb2"),
			SerializedData:    pulumi.String("{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook.  This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}"),
			SourceId:          pulumi.String("/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourcegroups/my-resource-group"),
			Tags: pulumi.StringMap{
				"TagSample01": pulumi.String("sample01"),
				"TagSample02": pulumi.String("sample02"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.applicationinsights.Workbook;
import com.pulumi.azurenative.applicationinsights.WorkbookArgs;
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 workbook = new Workbook("workbook", WorkbookArgs.builder()
            .category("workbook")
            .description("Sample workbook")
            .displayName("Sample workbook")
            .kind("shared")
            .location("westus")
            .resourceGroupName("my-resource-group")
            .resourceName("deadb33f-5e0d-4064-8ebb-1a4ed0313eb2")
            .serializedData("{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook.  This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}")
            .sourceId("/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourcegroups/my-resource-group")
            .tags(Map.ofEntries(
                Map.entry("TagSample01", "sample01"),
                Map.entry("TagSample02", "sample02")
            ))
            .build());

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

const workbook = new azure_native.applicationinsights.Workbook("workbook", {
    category: "workbook",
    description: "Sample workbook",
    displayName: "Sample workbook",
    kind: azure_native.applicationinsights.WorkbookSharedTypeKind.Shared,
    location: "westus",
    resourceGroupName: "my-resource-group",
    resourceName: "deadb33f-5e0d-4064-8ebb-1a4ed0313eb2",
    serializedData: "{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook.  This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}",
    sourceId: "/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourcegroups/my-resource-group",
    tags: {
        TagSample01: "sample01",
        TagSample02: "sample02",
    },
});
Copy
import pulumi
import pulumi_azure_native as azure_native

workbook = azure_native.applicationinsights.Workbook("workbook",
    category="workbook",
    description="Sample workbook",
    display_name="Sample workbook",
    kind=azure_native.applicationinsights.WorkbookSharedTypeKind.SHARED,
    location="westus",
    resource_group_name="my-resource-group",
    resource_name_="deadb33f-5e0d-4064-8ebb-1a4ed0313eb2",
    serialized_data="{\"version\":\"Notebook/1.0\",\"items\":[{\"type\":1,\"content\":\"{\"json\":\"## New workbook\\r\\n---\\r\\n\\r\\nWelcome to your new workbook.  This area will display text formatted as markdown.\\r\\n\\r\\n\\r\\nWe've included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections.\"}\",\"halfWidth\":null,\"conditionalVisibility\":null},{\"type\":3,\"content\":\"{\"version\":\"KqlItem/1.0\",\"query\":\"union withsource=TableName *\\n| summarize Count=count() by TableName\\n| render barchart\",\"showQuery\":false,\"size\":1,\"aggregation\":0,\"showAnnotations\":false}\",\"halfWidth\":null,\"conditionalVisibility\":null}],\"isLocked\":false}",
    source_id="/subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourcegroups/my-resource-group",
    tags={
        "TagSample01": "sample01",
        "TagSample02": "sample02",
    })
Copy
resources:
  workbook:
    type: azure-native:applicationinsights:Workbook
    properties:
      category: workbook
      description: Sample workbook
      displayName: Sample workbook
      kind: shared
      location: westus
      resourceGroupName: my-resource-group
      resourceName: deadb33f-5e0d-4064-8ebb-1a4ed0313eb2
      serializedData: '{"version":"Notebook/1.0","items":[{"type":1,"content":"{"json":"## New workbook\r\n---\r\n\r\nWelcome to your new workbook.  This area will display text formatted as markdown.\r\n\r\n\r\nWe''ve included a basic analytics query to get you started. Use the `Edit` button below each section to configure it or add more sections."}","halfWidth":null,"conditionalVisibility":null},{"type":3,"content":"{"version":"KqlItem/1.0","query":"union withsource=TableName *\n| summarize Count=count() by TableName\n| render barchart","showQuery":false,"size":1,"aggregation":0,"showAnnotations":false}","halfWidth":null,"conditionalVisibility":null}],"isLocked":false}'
      sourceId: /subscriptions/6b643656-33eb-422f-aee8-3ac145d124af/resourcegroups/my-resource-group
      tags:
        TagSample01: sample01
        TagSample02: sample02
Copy

Create Workbook Resource

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

Constructor syntax

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

@overload
def Workbook(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             resource_group_name: Optional[str] = None,
             serialized_data: Optional[str] = None,
             display_name: Optional[str] = None,
             category: Optional[str] = None,
             identity: Optional[WorkbookResourceIdentityArgs] = None,
             location: Optional[str] = None,
             kind: Optional[Union[str, WorkbookSharedTypeKind]] = None,
             resource_name_: Optional[str] = None,
             description: Optional[str] = None,
             source_id: Optional[str] = None,
             storage_uri: Optional[str] = None,
             tags: Optional[Mapping[str, str]] = None,
             version: Optional[str] = None)
func NewWorkbook(ctx *Context, name string, args WorkbookArgs, opts ...ResourceOption) (*Workbook, error)
public Workbook(string name, WorkbookArgs args, CustomResourceOptions? opts = null)
public Workbook(String name, WorkbookArgs args)
public Workbook(String name, WorkbookArgs args, CustomResourceOptions options)
type: azure-native:applicationinsights:Workbook
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. WorkbookArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. WorkbookArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. WorkbookArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. WorkbookArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

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

var workbookResource = new AzureNative.ApplicationInsights.Workbook("workbookResource", new()
{
    ResourceGroupName = "string",
    SerializedData = "string",
    DisplayName = "string",
    Category = "string",
    Identity = new AzureNative.ApplicationInsights.Inputs.WorkbookResourceIdentityArgs
    {
        Type = "string",
        UserAssignedIdentities = new[]
        {
            "string",
        },
    },
    Location = "string",
    Kind = "string",
    ResourceName = "string",
    Description = "string",
    SourceId = "string",
    StorageUri = "string",
    Tags = 
    {
        { "string", "string" },
    },
    Version = "string",
});
Copy
example, err := applicationinsights.NewWorkbook(ctx, "workbookResource", &applicationinsights.WorkbookArgs{
	ResourceGroupName: pulumi.String("string"),
	SerializedData:    pulumi.String("string"),
	DisplayName:       pulumi.String("string"),
	Category:          pulumi.String("string"),
	Identity: &applicationinsights.WorkbookResourceIdentityArgs{
		Type: pulumi.String("string"),
		UserAssignedIdentities: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	Location:     pulumi.String("string"),
	Kind:         pulumi.String("string"),
	ResourceName: pulumi.String("string"),
	Description:  pulumi.String("string"),
	SourceId:     pulumi.String("string"),
	StorageUri:   pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Version: pulumi.String("string"),
})
Copy
var workbookResource = new Workbook("workbookResource", WorkbookArgs.builder()
    .resourceGroupName("string")
    .serializedData("string")
    .displayName("string")
    .category("string")
    .identity(WorkbookResourceIdentityArgs.builder()
        .type("string")
        .userAssignedIdentities("string")
        .build())
    .location("string")
    .kind("string")
    .resourceName("string")
    .description("string")
    .sourceId("string")
    .storageUri("string")
    .tags(Map.of("string", "string"))
    .version("string")
    .build());
Copy
workbook_resource = azure_native.applicationinsights.Workbook("workbookResource",
    resource_group_name="string",
    serialized_data="string",
    display_name="string",
    category="string",
    identity={
        "type": "string",
        "user_assigned_identities": ["string"],
    },
    location="string",
    kind="string",
    resource_name_="string",
    description="string",
    source_id="string",
    storage_uri="string",
    tags={
        "string": "string",
    },
    version="string")
Copy
const workbookResource = new azure_native.applicationinsights.Workbook("workbookResource", {
    resourceGroupName: "string",
    serializedData: "string",
    displayName: "string",
    category: "string",
    identity: {
        type: "string",
        userAssignedIdentities: ["string"],
    },
    location: "string",
    kind: "string",
    resourceName: "string",
    description: "string",
    sourceId: "string",
    storageUri: "string",
    tags: {
        string: "string",
    },
    version: "string",
});
Copy
type: azure-native:applicationinsights:Workbook
properties:
    category: string
    description: string
    displayName: string
    identity:
        type: string
        userAssignedIdentities:
            - string
    kind: string
    location: string
    resourceGroupName: string
    resourceName: string
    serializedData: string
    sourceId: string
    storageUri: string
    tags:
        string: string
    version: string
Copy

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

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

The Workbook resource accepts the following input properties:

Category This property is required. string
Workbook category, as defined by the user at creation time.
DisplayName This property is required. string
The user-defined name (display name) of the workbook.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SerializedData This property is required. string
Configuration of this particular workbook. Configuration data is a string containing valid JSON
Description string
The description of the workbook.
Identity Pulumi.AzureNative.ApplicationInsights.Inputs.WorkbookResourceIdentity
Identity used for BYOS
Kind string | Pulumi.AzureNative.ApplicationInsights.WorkbookSharedTypeKind
The kind of workbook. Only valid value is shared.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
ResourceName Changes to this property will trigger replacement. string
The name of the workbook resource. The value must be an UUID.
SourceId string
ResourceId for a source resource.
StorageUri string
The resourceId to the storage account when bring your own storage is used
Tags Dictionary<string, string>
Resource tags.
Version string
Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData
Category This property is required. string
Workbook category, as defined by the user at creation time.
DisplayName This property is required. string
The user-defined name (display name) of the workbook.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
SerializedData This property is required. string
Configuration of this particular workbook. Configuration data is a string containing valid JSON
Description string
The description of the workbook.
Identity WorkbookResourceIdentityArgs
Identity used for BYOS
Kind string | WorkbookSharedTypeKind
The kind of workbook. Only valid value is shared.
Location Changes to this property will trigger replacement. string
The geo-location where the resource lives
ResourceName Changes to this property will trigger replacement. string
The name of the workbook resource. The value must be an UUID.
SourceId string
ResourceId for a source resource.
StorageUri string
The resourceId to the storage account when bring your own storage is used
Tags map[string]string
Resource tags.
Version string
Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData
category This property is required. String
Workbook category, as defined by the user at creation time.
displayName This property is required. String
The user-defined name (display name) of the workbook.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serializedData This property is required. String
Configuration of this particular workbook. Configuration data is a string containing valid JSON
description String
The description of the workbook.
identity WorkbookResourceIdentity
Identity used for BYOS
kind String | WorkbookSharedTypeKind
The kind of workbook. Only valid value is shared.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
resourceName Changes to this property will trigger replacement. String
The name of the workbook resource. The value must be an UUID.
sourceId String
ResourceId for a source resource.
storageUri String
The resourceId to the storage account when bring your own storage is used
tags Map<String,String>
Resource tags.
version String
Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData
category This property is required. string
Workbook category, as defined by the user at creation time.
displayName This property is required. string
The user-defined name (display name) of the workbook.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serializedData This property is required. string
Configuration of this particular workbook. Configuration data is a string containing valid JSON
description string
The description of the workbook.
identity WorkbookResourceIdentity
Identity used for BYOS
kind string | WorkbookSharedTypeKind
The kind of workbook. Only valid value is shared.
location Changes to this property will trigger replacement. string
The geo-location where the resource lives
resourceName Changes to this property will trigger replacement. string
The name of the workbook resource. The value must be an UUID.
sourceId string
ResourceId for a source resource.
storageUri string
The resourceId to the storage account when bring your own storage is used
tags {[key: string]: string}
Resource tags.
version string
Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData
category This property is required. str
Workbook category, as defined by the user at creation time.
display_name This property is required. str
The user-defined name (display name) of the workbook.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
serialized_data This property is required. str
Configuration of this particular workbook. Configuration data is a string containing valid JSON
description str
The description of the workbook.
identity WorkbookResourceIdentityArgs
Identity used for BYOS
kind str | WorkbookSharedTypeKind
The kind of workbook. Only valid value is shared.
location Changes to this property will trigger replacement. str
The geo-location where the resource lives
resource_name Changes to this property will trigger replacement. str
The name of the workbook resource. The value must be an UUID.
source_id str
ResourceId for a source resource.
storage_uri str
The resourceId to the storage account when bring your own storage is used
tags Mapping[str, str]
Resource tags.
version str
Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData
category This property is required. String
Workbook category, as defined by the user at creation time.
displayName This property is required. String
The user-defined name (display name) of the workbook.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serializedData This property is required. String
Configuration of this particular workbook. Configuration data is a string containing valid JSON
description String
The description of the workbook.
identity Property Map
Identity used for BYOS
kind String | "shared"
The kind of workbook. Only valid value is shared.
location Changes to this property will trigger replacement. String
The geo-location where the resource lives
resourceName Changes to this property will trigger replacement. String
The name of the workbook resource. The value must be an UUID.
sourceId String
ResourceId for a source resource.
storageUri String
The resourceId to the storage account when bring your own storage is used
tags Map<String>
Resource tags.
version String
Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData

Outputs

All input properties are implicitly available as output properties. Additionally, the Workbook resource produces the following output properties:

AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Revision string
The unique revision id for this workbook definition
SystemData Pulumi.AzureNative.ApplicationInsights.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
TimeModified string
Date and time in UTC of the last modification that was made to this workbook definition.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UserId string
Unique user id of the specific user that owns this workbook.
Etag string
Resource etag
AzureApiVersion string
The Azure API version of the resource.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The name of the resource
Revision string
The unique revision id for this workbook definition
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
TimeModified string
Date and time in UTC of the last modification that was made to this workbook definition.
Type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
UserId string
Unique user id of the specific user that owns this workbook.
Etag string
Resource etag
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
revision String
The unique revision id for this workbook definition
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
timeModified String
Date and time in UTC of the last modification that was made to this workbook definition.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
userId String
Unique user id of the specific user that owns this workbook.
etag String
Resource etag
azureApiVersion string
The Azure API version of the resource.
id string
The provider-assigned unique ID for this managed resource.
name string
The name of the resource
revision string
The unique revision id for this workbook definition
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
timeModified string
Date and time in UTC of the last modification that was made to this workbook definition.
type string
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
userId string
Unique user id of the specific user that owns this workbook.
etag string
Resource etag
azure_api_version str
The Azure API version of the resource.
id str
The provider-assigned unique ID for this managed resource.
name str
The name of the resource
revision str
The unique revision id for this workbook definition
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
time_modified str
Date and time in UTC of the last modification that was made to this workbook definition.
type str
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
user_id str
Unique user id of the specific user that owns this workbook.
etag str
Resource etag
azureApiVersion String
The Azure API version of the resource.
id String
The provider-assigned unique ID for this managed resource.
name String
The name of the resource
revision String
The unique revision id for this workbook definition
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
timeModified String
Date and time in UTC of the last modification that was made to this workbook definition.
type String
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
userId String
Unique user id of the specific user that owns this workbook.
etag String
Resource etag

Supporting Types

ManagedServiceIdentityType
, ManagedServiceIdentityTypeArgs

None
None
SystemAssigned
SystemAssigned
UserAssigned
UserAssigned
SystemAssigned_UserAssigned
SystemAssigned,UserAssigned
ManagedServiceIdentityTypeNone
None
ManagedServiceIdentityTypeSystemAssigned
SystemAssigned
ManagedServiceIdentityTypeUserAssigned
UserAssigned
ManagedServiceIdentityType_SystemAssigned_UserAssigned
SystemAssigned,UserAssigned
None
None
SystemAssigned
SystemAssigned
UserAssigned
UserAssigned
SystemAssigned_UserAssigned
SystemAssigned,UserAssigned
None
None
SystemAssigned
SystemAssigned
UserAssigned
UserAssigned
SystemAssigned_UserAssigned
SystemAssigned,UserAssigned
NONE
None
SYSTEM_ASSIGNED
SystemAssigned
USER_ASSIGNED
UserAssigned
SYSTEM_ASSIGNED_USER_ASSIGNED
SystemAssigned,UserAssigned
"None"
None
"SystemAssigned"
SystemAssigned
"UserAssigned"
UserAssigned
"SystemAssigned,UserAssigned"
SystemAssigned,UserAssigned

SystemDataResponse
, SystemDataResponseArgs

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The timestamp of resource last modification (UTC)
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The timestamp of resource last modification (UTC)
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The timestamp of resource last modification (UTC)
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The timestamp of resource last modification (UTC)
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

UserAssignedIdentityResponse
, UserAssignedIdentityResponseArgs

ClientId This property is required. string
The client ID of the assigned identity.
PrincipalId This property is required. string
The principal ID of the assigned identity.
ClientId This property is required. string
The client ID of the assigned identity.
PrincipalId This property is required. string
The principal ID of the assigned identity.
clientId This property is required. String
The client ID of the assigned identity.
principalId This property is required. String
The principal ID of the assigned identity.
clientId This property is required. string
The client ID of the assigned identity.
principalId This property is required. string
The principal ID of the assigned identity.
client_id This property is required. str
The client ID of the assigned identity.
principal_id This property is required. str
The principal ID of the assigned identity.
clientId This property is required. String
The client ID of the assigned identity.
principalId This property is required. String
The principal ID of the assigned identity.

WorkbookResourceIdentity
, WorkbookResourceIdentityArgs

Type This property is required. string | Pulumi.AzureNative.ApplicationInsights.ManagedServiceIdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities List<string>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
Type This property is required. string | ManagedServiceIdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities []string
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
type This property is required. String | ManagedServiceIdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities List<String>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
type This property is required. string | ManagedServiceIdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities string[]
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
type This property is required. str | ManagedServiceIdentityType
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
user_assigned_identities Sequence[str]
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
type This property is required. String | "None" | "SystemAssigned" | "UserAssigned" | "SystemAssigned,UserAssigned"
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities List<String>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

WorkbookResourceResponseIdentity
, WorkbookResourceResponseIdentityArgs

PrincipalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type This property is required. string
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.ApplicationInsights.Inputs.UserAssignedIdentityResponse>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
PrincipalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
TenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
Type This property is required. string
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
UserAssignedIdentities map[string]UserAssignedIdentityResponse
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. String
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. String
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<String,UserAssignedIdentityResponse>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. string
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. string
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. string
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities {[key: string]: UserAssignedIdentityResponse}
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principal_id This property is required. str
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenant_id This property is required. str
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. str
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
user_assigned_identities Mapping[str, UserAssignedIdentityResponse]
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.
principalId This property is required. String
The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.
tenantId This property is required. String
The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.
type This property is required. String
Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
userAssignedIdentities Map<Property Map>
The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.

WorkbookSharedTypeKind
, WorkbookSharedTypeKindArgs

Shared
shared
WorkbookSharedTypeKindShared
shared
Shared
shared
Shared
shared
SHARED
shared
"shared"
shared

Import

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

$ pulumi import azure-native:applicationinsights:Workbook deadb33f-5e0d-4064-8ebb-1a4ed0313eb2 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/workbooks/{resourceName} 
Copy

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

Package Details

Repository
Azure Native pulumi/pulumi-azure-native
License
Apache-2.0
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.2.0 published on Monday, Apr 14, 2025 by Pulumi