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

A workbook definition.

Name	Datatype	Description
etag	string	Resource etag
identity	object	Managed service identity (system assigned and/or user assigned identities)
kind	string	The kind of workbook. Only valid value is shared.
properties	object	Metadata describing a workbook for an Azure resource.
systemData	object	Metadata pertaining to creation and last modification of the resource.

list_by_resource_group

A list containing 0 or more workbook definitions.

Name	Datatype	Description
etag	string	Resource etag
identity	object	Managed service identity (system assigned and/or user assigned identities)
kind	string	The kind of workbook. Only valid value is shared.
properties	object	Metadata describing a workbook for an Azure resource.
systemData	object	Metadata pertaining to creation and last modification of the resource.

list_by_subscription

A list containing 0 or more workbook definitions.

Name	Datatype	Description
etag	string	Resource etag
identity	object	Managed service identity (system assigned and/or user assigned identities)
kind	string	The kind of workbook. Only valid value is shared.
properties	object	Metadata describing a workbook for an Azure resource.
systemData	object	Metadata pertaining to creation and last modification of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName	canFetchContent	Get a single workbook by its resourceName.
list_by_resource_group	select	subscriptionId, resourceGroupName, category	tags, sourceId, canFetchContent	Get all Workbooks defined within a specified resource group and category.
list_by_subscription	select	subscriptionId, category	tags, canFetchContent	Get all Workbooks defined within a specified subscription and category.
create_or_update	insert	subscriptionId, resourceGroupName, resourceName	sourceId	Create a new workbook.
update	update	subscriptionId, resourceGroupName, resourceName	sourceId	Updates a workbook that has already been added.
delete	delete	subscriptionId, resourceGroupName, resourceName		Delete a workbook.
revisions_list	exec	subscriptionId, resourceGroupName, resourceName		Get the revisions for the workbook defined by its resourceName.
revision_get	exec	subscriptionId, resourceGroupName, resourceName, revisionId		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.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
resourceName	string	The name of the workbook resource. The value must be an UUID.
revisionId	string	The id of the workbook's revision.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
canFetchContent	boolean	Flag indicating whether or not to return the full content for each applicable workbook. If false, only return summary content for workbooks.
sourceId	string	Azure Resource Id that will fetch all linked workbooks.
tags	array	Tags presents on each workbook returned.

SELECT examples

get

Get a single workbook by its resourceName.

SELECT
etag,
identity,
kind,
properties,
systemData
FROM azure.application_insights.workbooks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
AND canFetchContent = '{{ canFetchContent }}'
;

list_by_resource_group

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

SELECT
etag,
identity,
kind,
properties,
systemData
FROM azure.application_insights.workbooks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- 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
etag,
identity,
kind,
properties,
systemData
FROM azure.application_insights.workbooks
WHERE subscriptionId = '{{ subscriptionId }}' -- 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 (
data__identity,
data__kind,
data__etag,
data__properties,
subscriptionId,
resourceGroupName,
resourceName,
sourceId
)
SELECT 
'{{ identity }}',
'{{ kind }}',
'{{ etag }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ sourceId }}'
RETURNING
etag,
identity,
kind,
properties,
systemData
;

Manifest

# Description fields are for documentation purposes
- name: workbooks
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the workbooks resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the workbooks resource.
    - name: resourceName
      value: string
      description: Required parameter for the workbooks resource.
    - name: identity
      value: object
      description: |
        Managed service identity (system assigned and/or user assigned identities)
    - name: kind
      value: string
      description: |
        The kind of workbook. Only valid value is shared.
      valid_values: ['shared']
    - name: etag
      value: string
      description: |
        Resource etag
    - name: properties
      value: object
      description: |
        Metadata describing a workbook for an Azure resource.
    - name: sourceId
      value: string
      description: Azure Resource Id that will fetch all linked workbooks.

UPDATE examples

update

Updates a workbook that has already been added.

UPDATE azure.application_insights.workbooks
SET 
data__kind = '{{ kind }}',
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
AND sourceId = '{{ sourceId}}'
RETURNING
etag,
identity,
kind,
properties,
systemData;

DELETE examples

delete

Delete a workbook.

DELETE FROM azure.application_insights.workbooks
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
;

Lifecycle Methods

revisions_list

Get the revisions for the workbook defined by its resourceName.

EXEC azure.application_insights.workbooks.revisions_list 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@resourceName='{{ resourceName }}' --required
;

revision_get

Get a single workbook revision defined by its revisionId.

EXEC azure.application_insights.workbooks.revision_get 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@resourceName='{{ resourceName }}' --required, 
@revisionId='{{ revisionId }}' --required
;