Workbook interface
An Application Insights workbook definition.
- Extends
Properties
category | Workbook category, as defined by the user at creation time. |
description | The description of the workbook. |
display |
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. |
serialized |
Configuration of this particular workbook. Configuration data is a string containing valid JSON |
source |
ResourceId for a source resource. |
storage |
The resourceId to the storage account when bring your own storage is used |
system |
NOTE: This property will not be serialized. It can only be populated by the server. |
time |
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. |
user |
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 |
workbook |
Being deprecated, please use the other tags field |
Inherited Properties
etag | Resource etag |
identity | Identity used for BYOS |
kind | The kind of workbook. Choices are user and shared. Possible values include: 'user', 'shared' |
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
NOTE: This property will not be serialized. It can only be populated by the server.
systemData?: SystemData
Property Value
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
workbookTags
Being deprecated, please use the other tags field
workbookTags?: string[]
Property Value
string[]
Inherited Property Details
etag
Resource etag
etag?: {[propertyName: string]: string}
Property Value
{[propertyName: string]: string}
Inherited From WorkbookResource.etag
identity
Identity used for BYOS
identity?: WorkbookResourceIdentity
Property Value
Inherited From WorkbookResource.identity
kind
The kind of workbook. Choices are user and shared. Possible values include: 'user', 'shared'
kind?: Kind
Property Value
Inherited From WorkbookResource.kind