workbooks

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

Overview

Name	workbooks
Type	Resource
Id	azure.application_insights.workbooks

Fields

vw_workbooks

Name	Datatype	Description
description	text	field from the properties object
category	text	field from the properties object
display_name	text	field from the properties object
etag	text	Resource etag
identity	text	Identity used for BYOS
kind	text	The kind of workbook. Only valid value is shared.
resourceGroupName	text	field from the properties object
resourceName	text	field from the properties object
revision	text	field from the properties object
serialized_data	text	field from the properties object
source_id	text	field from the properties object
storage_uri	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	field from the properties object
time_modified	text	field from the properties object
user_id	text	field from the properties object
version	text	field from the properties object

workbooks

Name	Datatype	Description
etag	string	Resource etag
identity	object	Identity used for BYOS
kind	string	The kind of workbook. Only valid value is shared.
properties	object	Properties that contain a workbook.
systemData	object	Metadata pertaining to creation and last modification of the resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, resourceName, subscriptionId	Get a single workbook by its resourceName.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Get all Workbooks defined within a specified resource group and category.
list_by_subscription	SELECT	subscriptionId	Get all Workbooks defined within a specified subscription and category.
create_or_update	INSERT	resourceGroupName, resourceName, subscriptionId	Create a new workbook.
delete	DELETE	resourceGroupName, resourceName, subscriptionId	Delete a workbook.
update	UPDATE	resourceGroupName, resourceName, subscriptionId	Updates a workbook that has already been added.
revision_get	EXEC	resourceGroupName, resourceName, revisionId, subscriptionId	Get a single workbook revision defined by its revisionId.
revisions_list	EXEC	resourceGroupName, resourceName, subscriptionId	Get the revisions for the workbook defined by its resourceName.

SELECT examples

Get all Workbooks defined within a specified subscription and category.

vw_workbooks

SELECT
description,
category,
display_name,
etag,
identity,
kind,
resourceGroupName,
resourceName,
revision,
serialized_data,
source_id,
storage_uri,
subscriptionId,
system_data,
tags,
time_modified,
user_id,
version
FROM azure.application_insights.vw_workbooks
WHERE subscriptionId = '{{ subscriptionId }}';

workbooks

SELECT
etag,
identity,
kind,
properties,
systemData
FROM azure.application_insights.workbooks
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new workbooks resource.

All Properties

/*+ create */
INSERT INTO azure.application_insights.workbooks (
resourceGroupName,
resourceName,
subscriptionId,
identity,
kind,
etag,
properties
)
SELECT 
'{{ resourceGroupName }}',
'{{ resourceName }}',
'{{ subscriptionId }}',
'{{ identity }}',
'{{ kind }}',
'{{ etag }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: identity
      value: string
    - name: kind
      value: string
    - name: etag
      value: string
    - name: properties
      value:
        - name: displayName
          value: string
        - name: serializedData
          value: string
        - name: version
          value: string
        - name: timeModified
          value: string
        - name: category
          value: string
        - name: tags
          value:
            - string
        - name: userId
          value: string
        - name: sourceId
          value: string
        - name: storageUri
          value: string
        - name: description
          value: string
        - name: revision
          value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string

UPDATE example

Updates a workbooks resource.

/*+ update */
UPDATE azure.application_insights.workbooks
SET 
kind = '{{ kind }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified workbooks resource.

/*+ delete */
DELETE FROM azure.application_insights.workbooks
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND resourceName = '{{ resourceName }}'
AND subscriptionId = '{{ subscriptionId }}';