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

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.
author	string	Information about the author of the workbook template.
galleries	array	Workbook galleries supported by the template. Required.
localized	object	Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal.
location	string	The geo-location where the resource lives. Required.
priority	integer	Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
templateData	object	Valid JSON object containing workbook template payload. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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.
author	string	Information about the author of the workbook template.
galleries	array	Workbook galleries supported by the template. Required.
localized	object	Key value pair of localized gallery. Each key is the locale code of languages supported by the Azure portal.
location	string	The geo-location where the resource lives. Required.
priority	integer	Priority of the template. Determines which template to open when a workbook gallery is opened in viewer mode.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
templateData	object	Valid JSON object containing workbook template payload. Required.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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		Get a single workbook template by its resourceName.
list_by_resource_group	select	resource_group_name, subscription_id		Get all Workbook templates defined within a specified resource group.
create_or_update	insert	resource_group_name, resource_name, subscription_id, location		Create a new workbook template.
update	update	resource_group_name, resource_name, subscription_id		Updates a workbook template that has already been added.
create_or_update	replace	resource_group_name, resource_name, subscription_id, location		Create a new workbook template.
delete	delete	resource_group_name, resource_name, subscription_id		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
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
resource_name	string	The name of the Application Insights component resource. Required.
subscription_id	string

SELECT examples

get

Get a single workbook template by its resourceName.

SELECT
id,
name,
author,
galleries,
localized,
location,
priority,
systemData,
tags,
templateData,
type
FROM azure.application_insights.workbook_templates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_name = '{{ resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Get all Workbook templates defined within a specified resource group.

SELECT
id,
name,
author,
galleries,
localized,
location,
priority,
systemData,
tags,
templateData,
type
FROM azure.application_insights.workbook_templates
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create a new workbook template.

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

Manifest

# Description fields are for documentation purposes
- name: workbook_templates
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the workbook_templates resource.
  - name: resource_name
    value: "{{ resource_name }}"
    description: Required parameter for the workbook_templates resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the workbook_templates 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 template for an Azure resource.
    value:
      priority: {{ priority }}
      author: "{{ author }}"
      templateData: "{{ templateData }}"
      galleries:
        - name: "{{ name }}"
          category: "{{ category }}"
          type: "{{ type }}"
          order: {{ order }}
          resourceType: "{{ resourceType }}"
      localized: "{{ localized }}"

UPDATE examples

update

Updates a workbook template that has already been added.

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

REPLACE examples

create_or_update

Create a new workbook template.

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

DELETE examples

delete

Delete a workbook template.

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