Workbook interface

  • Reference
Package:
@azure/arm-appinsights

A workbook definition.

Extends
WorkbookResource

Properties

category

Workbook category, as defined by the user at creation time.
description

The description of the workbook.
displayName

The user-defined name (display name) of the workbook.
revision

The unique revision id for this workbook definition NOTE: This property will not be serialized. It can only be populated by the server.
serializedData

Configuration of this particular workbook. Configuration data is a string containing valid JSON
sourceId

ResourceId for a source resource.
storageUri

The resourceId to the storage account when bring your own storage is used
systemData

Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.
tagsPropertiesTags

Being deprecated, please use the other tags field
timeModified

Date and time in UTC of the last modification that was made to this workbook definition. NOTE: This property will not be serialized. It can only be populated by the server.
userId

Unique user id of the specific user that owns this workbook. NOTE: This property will not be serialized. It can only be populated by the server.
version

Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData

Inherited Properties

etag

Resource etag
id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
identity

Identity used for BYOS
kind

The kind of workbook. Only valid value is shared.
location

The geo-location where the resource lives
name

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

Resource tags.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

category

Workbook category, as defined by the user at creation time.

category?: string

Property Value

string

description

The description of the workbook.

description?: string

Property Value

string

displayName

The user-defined name (display name) of the workbook.

displayName?: string

Property Value

string

revision

The unique revision id for this workbook definition NOTE: This property will not be serialized. It can only be populated by the server.

revision?: string

Property Value

string

serializedData

Configuration of this particular workbook. Configuration data is a string containing valid JSON

serializedData?: string

Property Value

string

sourceId

ResourceId for a source resource.

sourceId?: string

Property Value

string

storageUri

The resourceId to the storage account when bring your own storage is used

storageUri?: string

Property Value

string

systemData

Metadata pertaining to creation and last modification of the resource. NOTE: This property will not be serialized. It can only be populated by the server.

systemData?: SystemData

Property Value

SystemData

tagsPropertiesTags

Being deprecated, please use the other tags field

tagsPropertiesTags?: string[]

Property Value

string[]

timeModified

Date and time in UTC of the last modification that was made to this workbook definition. NOTE: This property will not be serialized. It can only be populated by the server.

timeModified?: Date

Property Value

Date

userId

Unique user id of the specific user that owns this workbook. NOTE: This property will not be serialized. It can only be populated by the server.

userId?: string

Property Value

string

version

Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData

version?: string

Property Value

string

Inherited Property Details

etag

Resource etag

etag?: string

Property Value

string

Inherited From WorkbookResource.etag

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From WorkbookResource.id

identity

Identity used for BYOS

identity?: WorkbookResourceIdentity

Property Value

WorkbookResourceIdentity

Inherited From WorkbookResource.identity

kind

The kind of workbook. Only valid value is shared.

kind?: string

Property Value

string

Inherited From WorkbookResource.kind

location

The geo-location where the resource lives

location: string

Property Value

string

Inherited From WorkbookResource.location

name

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

name?: string

Property Value

string

Inherited From WorkbookResource.name

tags

Resource tags.

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

Property Value

{[propertyName: string]: string}

Inherited From WorkbookResource.tags

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From WorkbookResource.type