dashboards

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

Overview

Name	dashboards
Type	Resource
Id	azure.portal.dashboards

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_resource_group

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_subscription

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

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

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

SELECT examples

get

Gets the Dashboard.

SELECT
location,
properties,
tags
FROM azure.portal.dashboards
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND dashboardName = '{{ dashboardName }}' -- required
;

list_by_resource_group

Gets all the Dashboards within a resource group.

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

list_by_subscription

Gets all the dashboards within a subscription.

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

INSERT examples

create_or_update

Creates or updates a Dashboard.

INSERT INTO azure.portal.dashboards (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
dashboardName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ dashboardName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: dashboards
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the dashboards resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the dashboards resource.
    - name: dashboardName
      value: string
      description: Required parameter for the dashboards resource.
    - name: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Updates an existing Dashboard.

UPDATE azure.portal.dashboards
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dashboardName = '{{ dashboardName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes the Dashboard.

DELETE FROM azure.portal.dashboards
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND dashboardName = '{{ dashboardName }}' --required
;