dashboards

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

Overview

Name	dashboards
Type	Resource
Id	azure.portal.dashboards

Fields

vw_dashboards

Name	Datatype	Description
dashboardName	text	field from the properties object
lenses	text	field from the properties object
location	text	The geo-location where the resource lives
metadata	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
subscriptionId	text	field from the properties object
tags	text	Resource tags.

dashboards

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Dashboard Properties with Provisioning state
tags	object	Resource tags.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	dashboardName, resourceGroupName, subscriptionId	Gets the Dashboard.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Gets all the Dashboards within a resource group.
list_by_subscription	SELECT	subscriptionId	Gets all the dashboards within a subscription.
create_or_update	INSERT	dashboardName, resourceGroupName, subscriptionId	Creates or updates a Dashboard.
delete	DELETE	dashboardName, resourceGroupName, subscriptionId	Deletes the Dashboard.
update	UPDATE	dashboardName, resourceGroupName, subscriptionId	Updates an existing Dashboard.

SELECT examples

Gets all the dashboards within a subscription.

vw_dashboards

SELECT
dashboardName,
lenses,
location,
metadata,
provisioning_state,
resourceGroupName,
subscriptionId,
tags
FROM azure.portal.vw_dashboards
WHERE subscriptionId = '{{ subscriptionId }}';

dashboards

SELECT
location,
properties,
tags
FROM azure.portal.dashboards
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.portal.dashboards (
dashboardName,
resourceGroupName,
subscriptionId,
properties,
tags,
location
)
SELECT 
'{{ dashboardName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: properties
      value:
        - name: lenses
          value:
            - - name: order
                value: integer
              - name: parts
                value:
                  - - name: position
                      value:
                        - name: x
                          value: integer
                        - name: 'y'
                          value: integer
                        - name: rowSpan
                          value: integer
                        - name: colSpan
                          value: integer
                        - name: metadata
                          value: object
                    - name: metadata
                      value:
                        - name: type
                          value: []
              - name: metadata
                value: object
        - name: metadata
          value: object
        - name: provisioningState
          value: []
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a dashboards resource.

/*+ update */
UPDATE azure.portal.dashboards
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
dashboardName = '{{ dashboardName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified dashboards resource.

/*+ delete */
DELETE FROM azure.portal.dashboards
WHERE dashboardName = '{{ dashboardName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';