workbooks

Creates, updates, deletes, gets or lists a workbooks resource.

Overview

Name	workbooks
Type	Resource
Id	azure.application_insights.workbooks

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
category	string	Workbook category, as defined by the user at creation time. Required.
description	string	The description of the workbook.
displayName	string	The user-defined name (display name) of the workbook. Required.
etag	string	Resource etag.
identity	object	Identity used for BYOS.
kind	string	The kind of workbook. Only valid value is shared. "shared" (shared)
location	string	The geo-location where the resource lives. Required.
revision	string	The unique revision id for this workbook definition.
serializedData	string	Configuration of this particular workbook. Configuration data is a string containing valid JSON. Required.
sourceId	string	ResourceId for a source resource.
storageUri	string	The resourceId to the storage account when bring your own storage is used.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
timeModified	string (date-time)	Date and time in UTC of the last modification that was made to this workbook definition.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userId	string	Unique user id of the specific user that owns this workbook.
version	string	Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
category	string	Workbook category, as defined by the user at creation time. Required.
description	string	The description of the workbook.
displayName	string	The user-defined name (display name) of the workbook. Required.
etag	string	Resource etag.
identity	object	Identity used for BYOS.
kind	string	The kind of workbook. Only valid value is shared. "shared" (shared)
location	string	The geo-location where the resource lives. Required.
revision	string	The unique revision id for this workbook definition.
serializedData	string	Configuration of this particular workbook. Configuration data is a string containing valid JSON. Required.
sourceId	string	ResourceId for a source resource.
storageUri	string	The resourceId to the storage account when bring your own storage is used.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
timeModified	string (date-time)	Date and time in UTC of the last modification that was made to this workbook definition.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userId	string	Unique user id of the specific user that owns this workbook.
version	string	Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData.

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
category	string	Workbook category, as defined by the user at creation time. Required.
description	string	The description of the workbook.
displayName	string	The user-defined name (display name) of the workbook. Required.
etag	string	Resource etag.
identity	object	Identity used for BYOS.
kind	string	The kind of workbook. Only valid value is shared. "shared" (shared)
location	string	The geo-location where the resource lives. Required.
revision	string	The unique revision id for this workbook definition.
serializedData	string	Configuration of this particular workbook. Configuration data is a string containing valid JSON. Required.
sourceId	string	ResourceId for a source resource.
storageUri	string	The resourceId to the storage account when bring your own storage is used.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
timeModified	string (date-time)	Date and time in UTC of the last modification that was made to this workbook definition.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userId	string	Unique user id of the specific user that owns this workbook.
version	string	Workbook schema version format, like 'Notebook/1.0', which should match the workbook in serializedData.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, resource_name, subscription_id	canFetchContent	Get a single workbook by its resourceName.
list_by_resource_group	select	resource_group_name, subscription_id, category	tags, sourceId, canFetchContent	Get all Workbooks defined within a specified resource group and category.
list_by_subscription	select	subscription_id, category	tags, canFetchContent	Get all Workbooks defined within a specified subscription and category.
create_or_update	insert	resource_group_name, resource_name, subscription_id, location	sourceId	Create a new workbook.
update	update	resource_group_name, resource_name, subscription_id	sourceId	Updates a workbook that has already been added.
create_or_update	replace	resource_group_name, resource_name, subscription_id, location	sourceId	Create a new workbook.
delete	delete	resource_group_name, resource_name, subscription_id		Delete a workbook.
revisions_list	exec	resource_group_name, resource_name, subscription_id		Get the revisions for the workbook defined by its resourceName.
revision_get	exec	resource_group_name, resource_name, revision_id, subscription_id		Get a single workbook revision defined by its revisionId.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
category	string	Category of workbook to return. Known values are: "workbook", "TSG", "performance", and "retention". Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the workbook resource. The value must be an UUID. Required.
revision_id	string	The id of the workbook's revision. Required.
subscription_id	string
canFetchContent	boolean	Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks. Default value is None.
sourceId	string	Azure Resource Id that will fetch all linked workbooks. Default value is None.
tags	array	Tags presents on each workbook returned. Default value is None.

SELECT examples

get

Get a single workbook by its resourceName.

SELECT
id,
name,
category,
description,
displayName,
etag,
identity,
kind,
location,
revision,
serializedData,
sourceId,
storageUri,
systemData,
tags,
timeModified,
type,
userId,
version
FROM azure.application_insights.workbooks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND canFetchContent = '{{ canFetchContent }}'
;

list_by_resource_group

Get all Workbooks defined within a specified resource group and category.

SELECT
id,
name,
category,
description,
displayName,
etag,
identity,
kind,
location,
revision,
serializedData,
sourceId,
storageUri,
systemData,
tags,
timeModified,
type,
userId,
version
FROM azure.application_insights.workbooks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND category = '{{ category }}' -- required
AND tags = '{{ tags }}'
AND sourceId = '{{ sourceId }}'
AND canFetchContent = '{{ canFetchContent }}'
;

list_by_subscription

Get all Workbooks defined within a specified subscription and category.

SELECT
id,
name,
category,
description,
displayName,
etag,
identity,
kind,
location,
revision,
serializedData,
sourceId,
storageUri,
systemData,
tags,
timeModified,
type,
userId,
version
FROM azure.application_insights.workbooks
WHERE subscription_id = '{{ subscription_id }}' -- required
AND category = '{{ category }}' -- required
AND tags = '{{ tags }}'
AND canFetchContent = '{{ canFetchContent }}'
;

INSERT examples

create_or_update

Create a new workbook.

INSERT INTO azure.application_insights.workbooks (
tags,
location,
properties,
identity,
kind,
etag,
resource_group_name,
resource_name,
subscription_id,
sourceId
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ kind }}',
'{{ etag }}',
'{{ resource_group_name }}',
'{{ resource_name }}',
'{{ subscription_id }}',
'{{ sourceId }}'
RETURNING
id,
name,
etag,
identity,
kind,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: workbooks
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workbooks resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the workbooks resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workbooks resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Metadata describing a workbook for an Azure resource.
    value:
      displayName: "{{ displayName }}"
      serializedData: "{{ serializedData }}"
      version: "{{ version }}"
      timeModified: "{{ timeModified }}"
      category: "{{ category }}"
      tags:
        - "{{ tags }}"
      userId: "{{ userId }}"
      sourceId: "{{ sourceId }}"
      storageUri: "{{ storageUri }}"
      description: "{{ description }}"
      revision: "{{ revision }}"
  - name: identity
    description: |
      Identity used for BYOS.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: kind
    value: "{{ kind }}"
    description: |
      The kind of workbook. Only valid value is shared. "shared"
    valid_values: ['shared']
  - name: etag
    value: "{{ etag }}"
    description: |
      Resource etag.
  - name: sourceId
    value: "{{ sourceId }}"
    description: Azure Resource Id that will fetch all linked workbooks. Default value is None.
    description: Azure Resource Id that will fetch all linked workbooks. Default value is None.

UPDATE examples

update

Updates a workbook that has already been added.

UPDATE azure.application_insights.workbooks
SET 
kind = '{{ kind }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND sourceId = '{{ sourceId}}'
RETURNING
id,
name,
etag,
identity,
kind,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a new workbook.

REPLACE azure.application_insights.workbooks
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}',
kind = '{{ kind }}',
etag = '{{ etag }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
AND sourceId = '{{ sourceId}}'
RETURNING
id,
name,
etag,
identity,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a workbook.

DELETE FROM azure.application_insights.workbooks
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_name = '{{ resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

revisions_list

Get the revisions for the workbook defined by its resourceName.

EXEC azure.application_insights.workbooks.revisions_list 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

revision_get

Get a single workbook revision defined by its revisionId.

EXEC azure.application_insights.workbooks.revision_get 
@resource_group_name='{{ resource_group_name }}' --required, 
@resource_name='{{ resource_name }}' --required, 
@revision_id='{{ revision_id }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;