Share via


Workbook Class

Definition

A workbook definition.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20220401.WorkbookTypeConverter))]
public class Workbook : Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20220401.IWorkbook, Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20220401.WorkbookTypeConverter))>]
type Workbook = class
    interface IWorkbook
    interface IJsonSerializable
    interface IWorkbookResource
    interface ITrackedResource
    interface IResource
    interface IValidates
Public Class Workbook
Implements IValidates, IWorkbook
Inheritance
Workbook
Attributes
Implements

Constructors

Workbook()

Creates an new Workbook instance.

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.

Etag

Resource etag

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

Identity

Identity used for BYOS

IdentityPrincipalId

The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.

IdentityTenantId

The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.

IdentityType

Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).

IdentityUserAssignedIdentity

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.

Kind

The kind of workbook. Only valid value is shared.

Location

The geo-location where the resource lives

Name

The name of the resource

PropertiesTag

Being deprecated, please use the other tags field

ResourceGroupName

Gets the resource group name

Revision

The unique revision id for this workbook definition

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

SystemDataCreatedAt

The timestamp of resource creation (UTC).

SystemDataCreatedBy

The identity that created the resource.

SystemDataCreatedByType

The type of identity that created the resource.

SystemDataLastModifiedAt

The timestamp of resource last modification (UTC)

SystemDataLastModifiedBy

The identity that last modified the resource.

SystemDataLastModifiedByType

The type of identity that last modified the resource.

Tag

Resource tags.

TimeModified

Date and time in UTC of the last modification that was made to this workbook definition.

Type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

UserId

Unique user id of the specific user that owns this workbook.

Version

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

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of Workbook.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of Workbook.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.ApplicationInsights.Models.Api20220401.IWorkbook.

FromJsonString(String)

Creates a new instance of Workbook, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of Workbook into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to