deleted_workbooks

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

Overview

Name	deleted_workbooks
Type	Resource
Id	azure.application_insights.deleted_workbooks

Fields

The following fields are returned by SELECT queries:

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.
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
list_by_subscription	select	subscription_id	category, tags	Get all recently deleted Workbooks in a specified subscription.

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
subscription_id	string
category	string	Category of workbook to return. Known values are: "workbook", "TSG", "performance", and "retention". Default value is None.
tags	array	Tags presents on each workbook returned. Default value is None.

SELECT examples

list_by_subscription

Get all recently deleted Workbooks in a specified subscription.

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