public interface Workbook
An immutable client-side representation of Workbook.
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    The entirety of the Workbook definition.
    static interface 
    The Workbook definition stages.
    static interface 
    The template for Workbook update.
    static interface 
    The Workbook update stages.
  • Method Summary

    Modifier and Type
    Method
    Description
    Gets the category property: Workbook category, as defined by the user at creation time.
    Gets the description property: The description of the workbook.
    Gets the displayName property: The user-defined name (display name) of the workbook.
    Gets the etag property: Resource etag.
    id()
    Gets the id property: Fully qualified resource Id for the resource.
    Gets the identity property: Identity used for BYOS.
    Gets the inner com.azure.resourcemanager.applicationinsights.fluent.models.WorkbookInner object.
    Gets the kind property: The kind of workbook.
    Gets the location property: The geo-location where the resource lives.
    Gets the name property: The name of the resource.
    Refreshes the resource to sync with Azure.
    refresh(com.azure.core.util.Context context)
    Refreshes the resource to sync with Azure.
    com.azure.core.management.Region
    Gets the region of the resource.
    Gets the name of the resource region.
    Gets the name of the resource group.
    Gets the revision property: The unique revision id for this workbook definition.
    Gets the serializedData property: Configuration of this particular workbook.
    Gets the sourceId property: ResourceId for a source resource.
    Gets the storageUri property: The resourceId to the storage account when bring your own storage is used.
    com.azure.core.management.SystemData
    Gets the systemData property: Metadata pertaining to creation and last modification of the resource.
    Gets the tags property: Resource tags.
    Gets the tagsPropertiesTags property: Being deprecated, please use the other tags field.
    Gets the timeModified property: Date and time in UTC of the last modification that was made to this workbook definition.
    Gets the type property: The type of the resource.
    Begins update for the Workbook resource.
    Gets the userId property: Unique user id of the specific user that owns this workbook.
    Gets the version property: Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData.
  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.
    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.
    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.
    • location

      String location()
      Gets the location property: The geo-location where the resource lives.
      Returns:
      the location value.
    • tags

      Map<String,String> tags()
      Gets the tags property: Resource tags.
      Returns:
      the tags value.
    • identity

      Gets the identity property: Identity used for BYOS.
      Returns:
      the identity value.
    • kind

      Gets the kind property: The kind of workbook. Only valid value is shared.
      Returns:
      the kind value.
    • etag

      String etag()
      Gets the etag property: Resource etag.
      Returns:
      the etag value.
    • systemData

      com.azure.core.management.SystemData systemData()
      Gets the systemData property: Metadata pertaining to creation and last modification of the resource.
      Returns:
      the systemData value.
    • displayName

      String displayName()
      Gets the displayName property: The user-defined name (display name) of the workbook.
      Returns:
      the displayName value.
    • serializedData

      String serializedData()
      Gets the serializedData property: Configuration of this particular workbook. Configuration data is a string containing valid JSON.
      Returns:
      the serializedData value.
    • version

      String version()
      Gets the version property: Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData.
      Returns:
      the version value.
    • timeModified

      OffsetDateTime timeModified()
      Gets the timeModified property: Date and time in UTC of the last modification that was made to this workbook definition.
      Returns:
      the timeModified value.
    • category

      String category()
      Gets the category property: Workbook category, as defined by the user at creation time.
      Returns:
      the category value.
    • tagsPropertiesTags

      List<String> tagsPropertiesTags()
      Gets the tagsPropertiesTags property: Being deprecated, please use the other tags field.
      Returns:
      the tagsPropertiesTags value.
    • userId

      String userId()
      Gets the userId property: Unique user id of the specific user that owns this workbook.
      Returns:
      the userId value.
    • sourceId

      String sourceId()
      Gets the sourceId property: ResourceId for a source resource.
      Returns:
      the sourceId value.
    • storageUri

      String storageUri()
      Gets the storageUri property: The resourceId to the storage account when bring your own storage is used.
      Returns:
      the storageUri value.
    • description

      String description()
      Gets the description property: The description of the workbook.
      Returns:
      the description value.
    • revision

      String revision()
      Gets the revision property: The unique revision id for this workbook definition.
      Returns:
      the revision value.
    • region

      com.azure.core.management.Region region()
      Gets the region of the resource.
      Returns:
      the region of the resource.
    • regionName

      String regionName()
      Gets the name of the resource region.
      Returns:
      the name of the resource region.
    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.
    • innerModel

      WorkbookInner innerModel()
      Gets the inner com.azure.resourcemanager.applicationinsights.fluent.models.WorkbookInner object.
      Returns:
      the inner object.
    • update

      Workbook.Update update()
      Begins update for the Workbook resource.
      Returns:
      the stage of resource update.
    • refresh

      Workbook refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.
    • refresh

      Workbook refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.