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

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
lenses	array	The dashboard lenses.
location	string	The geo-location where the resource lives. Required.
metadata	object	The dashboard metadata.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", and "Canceled".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
lenses	array	The dashboard lenses.
location	string	The geo-location where the resource lives. Required.
metadata	object	The dashboard metadata.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", and "Canceled".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}".
name	string	The name of the resource.
lenses	array	The dashboard lenses.
location	string	The geo-location where the resource lives. Required.
metadata	object	The dashboard metadata.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", and "Canceled".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, dashboard_name, subscription_id		Gets the Dashboard.
list_by_resource_group	select	resource_group_name, subscription_id		Gets all the Dashboards within a resource group.
list_by_subscription	select	subscription_id		Gets all the dashboards within a subscription.
create_or_update	insert	resource_group_name, dashboard_name, subscription_id, location		Creates or updates a Dashboard.
update	update	resource_group_name, dashboard_name, subscription_id		Updates an existing Dashboard.
create_or_update	replace	resource_group_name, dashboard_name, subscription_id, location		Creates or updates a Dashboard.
delete	delete	resource_group_name, dashboard_name, subscription_id		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
dashboard_name	string	The name of the dashboard. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the Dashboard.

SELECT
id,
name,
lenses,
location,
metadata,
provisioningState,
systemData,
tags,
type
FROM azure.portal.dashboards
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND dashboard_name = '{{ dashboard_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets all the Dashboards within a resource group.

SELECT
id,
name,
lenses,
location,
metadata,
provisioningState,
systemData,
tags,
type
FROM azure.portal.dashboards
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Gets all the dashboards within a subscription.

SELECT
id,
name,
lenses,
location,
metadata,
provisioningState,
systemData,
tags,
type
FROM azure.portal.dashboards
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a Dashboard.

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

Manifest

# Description fields are for documentation purposes
- name: dashboards
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the dashboards resource.
  - name: dashboard_name
    value: "{{ dashboard_name }}"
    description: Required parameter for the dashboards resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the dashboards resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      lenses:
        - order: {{ order }}
          parts: "{{ parts }}"
          metadata: "{{ metadata }}"
      metadata: "{{ metadata }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Updates an existing Dashboard.

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

REPLACE examples

create_or_update

Creates or updates a Dashboard.

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

DELETE examples

delete

Deletes the Dashboard.

DELETE FROM azure.portal.dashboards
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND dashboard_name = '{{ dashboard_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;