grafana

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

Overview

Name	grafana
Type	Resource
Id	azure.dashboard.grafana

Fields

The following fields are returned by SELECT queries:

get

OK. Return the properties of the required workspace for Grafana resource.

Name	Datatype	Description
id	string	ARM id of the grafana resource
name	string	Name of the grafana resource.
identity	object	The managed identity of the grafana resource.
location	string	The geo-location where the grafana resource lives
properties	object	Properties specific to the grafana resource.
sku	object	The Sku of the grafana resource.
systemData	object	The system meta data relating to this grafana resource.
tags	object	The tags for grafana resource.
type	string	The type of the grafana resource.

list_by_resource_group

OK. Return all resources of workspaces for Grafana under the given resource group.

Name	Datatype	Description
id	string	ARM id of the grafana resource
name	string	Name of the grafana resource.
identity	object	The managed identity of the grafana resource.
location	string	The geo-location where the grafana resource lives
properties	object	Properties specific to the grafana resource.
sku	object	The Sku of the grafana resource.
systemData	object	The system meta data relating to this grafana resource.
tags	object	The tags for grafana resource.
type	string	The type of the grafana resource.

list

OK. Return all resources of workspaces for Grafana under the specified subscription.

Name	Datatype	Description
id	string	ARM id of the grafana resource
name	string	Name of the grafana resource.
identity	object	The managed identity of the grafana resource.
location	string	The geo-location where the grafana resource lives
properties	object	Properties specific to the grafana resource.
sku	object	The Sku of the grafana resource.
systemData	object	The system meta data relating to this grafana resource.
tags	object	The tags for grafana resource.
type	string	The type of the grafana resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, workspaceName
list_by_resource_group	select	subscriptionId, resourceGroupName
list	select	subscriptionId
create	insert	subscriptionId, resourceGroupName, workspaceName
update	update	subscriptionId, resourceGroupName, workspaceName
delete	delete	subscriptionId, resourceGroupName, workspaceName
check_enterprise_details	exec	subscriptionId, resourceGroupName, workspaceName
fetch_available_plugins	exec	subscriptionId, resourceGroupName, workspaceName

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.
workspaceName	string	The workspace name of Azure Managed Grafana.

SELECT examples

get

OK. Return the properties of the required workspace for Grafana resource.

SELECT
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.dashboard.grafana
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND workspaceName = '{{ workspaceName }}' -- required
;

list_by_resource_group

OK. Return all resources of workspaces for Grafana under the given resource group.

SELECT
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.dashboard.grafana
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list

OK. Return all resources of workspaces for Grafana under the specified subscription.

SELECT
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure.dashboard.grafana
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

No description available.

INSERT INTO azure.dashboard.grafana (
data__sku,
data__properties,
data__identity,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
workspaceName
)
SELECT 
'{{ sku }}',
'{{ properties }}',
'{{ identity }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ workspaceName }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: grafana
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the grafana resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the grafana resource.
    - name: workspaceName
      value: string
      description: Required parameter for the grafana resource.
    - name: sku
      value: object
      description: |
        The Sku of the grafana resource.
    - name: properties
      value: object
      description: |
        Properties specific to the grafana resource.
    - name: identity
      value: object
      description: |
        The managed identity of the grafana resource.
    - name: tags
      value: object
      description: |
        The tags for grafana resource.
    - name: location
      value: string
      description: |
        The geo-location where the grafana resource lives

UPDATE examples

update

No description available.

UPDATE azure.dashboard.grafana
SET 
data__sku = '{{ sku }}',
data__identity = '{{ identity }}',
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

No description available.

DELETE FROM azure.dashboard.grafana
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND workspaceName = '{{ workspaceName }}' --required
;

Lifecycle Methods

check_enterprise_details

OK. Successfully retrieve the enterprise details information of a workspace for a Grafana resource.

EXEC azure.dashboard.grafana.check_enterprise_details 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required
;

fetch_available_plugins

Success

EXEC azure.dashboard.grafana.fetch_available_plugins 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@workspaceName='{{ workspaceName }}' --required
;