WorkbookTemplate interface

An Application Insights workbook template definition.

Extends

Properties

author

Information about the author of the workbook template.

galleries

Workbook galleries supported by the template.

localized

Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal.

priority

Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode.

templateData

Valid JSON object containing workbook template payload.

Inherited Properties

id

Azure resource Id NOTE: This property will not be serialized. It can only be populated by the server.

location

Resource location

name

Azure resource name. NOTE: This property will not be serialized. It can only be populated by the server.

tags

Resource tags

type

Azure resource type NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

author

Information about the author of the workbook template.

author?: string

Property Value

string

galleries

Workbook galleries supported by the template.

galleries?: WorkbookTemplateGallery[]

Property Value

localized

Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal.

localized?: {[propertyName: string]: WorkbookTemplateLocalizedGallery[]}

Property Value

{[propertyName: string]: WorkbookTemplateLocalizedGallery[]}

priority

Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode.

priority?: number

Property Value

number

templateData

Valid JSON object containing workbook template payload.

templateData?: Record<string, unknown>

Property Value

Record<string, unknown>

Inherited Property Details

id

Azure resource Id NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From WorkbookTemplateResource.id

location

Resource location

location: string

Property Value

string

Inherited From WorkbookTemplateResource.location

name

Azure resource name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From WorkbookTemplateResource.name

tags

Resource tags

tags?: {[propertyName: string]: string}

Property Value

{[propertyName: string]: string}

Inherited From WorkbookTemplateResource.tags

type

Azure resource type NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From WorkbookTemplateResource.type