managed_dashboards

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

Overview

Name	managed_dashboards
Type	Resource
Id	azure.dashboard.managed_dashboards

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.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified". (Accepted, Creating, Updating, Deleting, Succeeded, Failed, Canceled, Deleted, NotSpecified)
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

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.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified". (Accepted, Creating, Updating, Deleting, Succeeded, Failed, Canceled, Deleted, NotSpecified)
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. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified". (Accepted, Creating, Updating, Deleting, Succeeded, Failed, Canceled, Deleted, NotSpecified)
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		Get the properties of a specific dashboard for grafana resource.
list	select	resource_group_name, subscription_id		List all resources of dashboards under the specified resource group.
list_by_subscription	select	subscription_id		List all resources of dashboards under the specified subscription.
create	insert	resource_group_name, dashboard_name, subscription_id, location		Create or update a dashboard for grafana resource. This API is idempotent, so user can either create a new dashboard or update an existing dashboard.
update	update	resource_group_name, dashboard_name, subscription_id		Update a dashboard for Grafana resource.
delete	delete	resource_group_name, dashboard_name, subscription_id		Delete a dashboard for Grafana resource.

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 Azure Managed Dashboard. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get the properties of a specific dashboard for grafana resource.

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

list

List all resources of dashboards under the specified resource group.

SELECT
id,
name,
location,
provisioningState,
systemData,
tags,
type
FROM azure.dashboard.managed_dashboards
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List all resources of dashboards under the specified subscription.

SELECT
id,
name,
location,
provisioningState,
systemData,
tags,
type
FROM azure.dashboard.managed_dashboards
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create or update a dashboard for grafana resource. This API is idempotent, so user can either create a new dashboard or update an existing dashboard.

INSERT INTO azure.dashboard.managed_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: managed_dashboards
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the managed_dashboards resource.
  - name: dashboard_name
    value: "{{ dashboard_name }}"
    description: Required parameter for the managed_dashboards resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the managed_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: |
      Properties specific to the managed dashboard resource.
    value:
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update a dashboard for Grafana resource.

UPDATE azure.dashboard.managed_dashboards
SET 
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;

DELETE examples

delete

Delete a dashboard for Grafana resource.

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