workbook_templates

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

Overview

Name	workbook_templates
Type	Resource
Id	azure.application_insights.workbook_templates

Fields

The following fields are returned by SELECT queries:

get

A workbook template definition.

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name.
location	string	Resource location
properties	object	Metadata describing a workbook template for an Azure resource.
tags	object	Resource tags
type	string	Azure resource type

list_by_resource_group

A list containing 0 or more workbook template definitions.

Name	Datatype	Description
id	string	Azure resource Id
name	string	Azure resource name.
location	string	Resource location
properties	object	Metadata describing a workbook template for an Azure resource.
tags	object	Resource tags
type	string	Azure resource type

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, resourceName		Get a single workbook template by its resourceName.
list_by_resource_group	select	subscriptionId, resourceGroupName		Get all Workbook templates defined within a specified resource group.
create_or_update	insert	subscriptionId, resourceGroupName, resourceName		Create a new workbook template.
update	update	subscriptionId, resourceGroupName, resourceName		Updates a workbook template that has already been added.
delete	delete	subscriptionId, resourceGroupName, resourceName		Delete a workbook template.

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
resourceName	string	The name of the Application Insights component resource.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Get a single workbook template by its resourceName.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.application_insights.workbook_templates
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND resourceName = '{{ resourceName }}' -- required
;

list_by_resource_group

Get all Workbook templates defined within a specified resource group.

SELECT
id,
name,
location,
properties,
tags,
type
FROM azure.application_insights.workbook_templates
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

INSERT examples

create_or_update

Create a new workbook template.

INSERT INTO azure.application_insights.workbook_templates (
data__location,
data__tags,
data__properties,
subscriptionId,
resourceGroupName,
resourceName
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ resourceName }}'
RETURNING
id,
name,
location,
properties,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: workbook_templates
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the workbook_templates resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the workbook_templates resource.
    - name: resourceName
      value: string
      description: Required parameter for the workbook_templates resource.
    - name: location
      value: string
      description: |
        Resource location
    - name: tags
      value: object
      description: |
        Resource tags
    - name: properties
      value: object
      description: |
        Metadata describing a workbook template for an Azure resource.

UPDATE examples

update

Updates a workbook template that has already been added.

UPDATE azure.application_insights.workbook_templates
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND resourceName = '{{ resourceName }}' --required
RETURNING
id,
name,
location,
properties,
tags,
type;

DELETE examples

delete

Delete a workbook template.

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