grafana

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

Overview

Name	grafana
Type	Resource
Id	azure.dashboard.grafana

Fields

vw_grafana

Name	Datatype	Description
id	text	ARM id of the grafana resource
name	text	Name of the grafana resource.
api_key	text	field from the properties object
auto_generated_domain_name_label_scope	text	field from the properties object
deterministic_outbound_ip	text	field from the properties object
endpoint	text	field from the properties object
enterprise_configurations	text	field from the properties object
grafana_configurations	text	field from the properties object
grafana_integrations	text	field from the properties object
grafana_major_version	text	field from the properties object
grafana_plugins	text	field from the properties object
grafana_version	text	field from the properties object
identity	text	Managed service identity (system assigned and/or user assigned identities)
location	text	The geo-location where the grafana resource lives
outbound_ips	text	field from the properties object
private_endpoint_connections	text	field from the properties object
provisioning_state	text	field from the properties object
public_network_access	text	field from the properties object
resourceGroupName	text	field from the properties object
sku	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	The tags for grafana resource.
type	text	The type of the grafana resource.
workspaceName	text	field from the properties object
zone_redundancy	text	field from the properties object

grafana

Name	Datatype	Description
id	string	ARM id of the grafana resource
name	string	Name of the grafana resource.
identity	object	Managed service identity (system assigned and/or user assigned identities)
location	string	The geo-location where the grafana resource lives
properties	object	Properties specific to the grafana resource.
sku	object
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	The tags for grafana resource.
type	string	The type of the grafana resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	resourceGroupName, subscriptionId, workspaceName
list	SELECT	subscriptionId
list_by_resource_group	SELECT	resourceGroupName, subscriptionId
create	INSERT	resourceGroupName, subscriptionId, workspaceName
delete	DELETE	resourceGroupName, subscriptionId, workspaceName
update	UPDATE	resourceGroupName, subscriptionId, workspaceName
check_enterprise_details	EXEC	resourceGroupName, subscriptionId, workspaceName
fetch_available_plugins	EXEC	resourceGroupName, subscriptionId, workspaceName

SELECT examples

vw_grafana

SELECT
id,
name,
api_key,
auto_generated_domain_name_label_scope,
deterministic_outbound_ip,
endpoint,
enterprise_configurations,
grafana_configurations,
grafana_integrations,
grafana_major_version,
grafana_plugins,
grafana_version,
identity,
location,
outbound_ips,
private_endpoint_connections,
provisioning_state,
public_network_access,
resourceGroupName,
sku,
subscriptionId,
system_data,
tags,
type,
workspaceName,
zone_redundancy
FROM azure.dashboard.vw_grafana
WHERE subscriptionId = '{{ subscriptionId }}';

grafana

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

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.dashboard.grafana (
resourceGroupName,
subscriptionId,
workspaceName,
sku,
properties,
identity,
systemData,
tags,
location
)
SELECT 
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ workspaceName }}',
'{{ sku }}',
'{{ properties }}',
'{{ identity }}',
'{{ systemData }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: sku
      value:
        - name: name
          value: string
    - name: properties
      value:
        - name: provisioningState
          value: []
        - name: grafanaVersion
          value: string
        - name: endpoint
          value: string
        - name: publicNetworkAccess
          value: []
        - name: zoneRedundancy
          value: []
        - name: apiKey
          value: []
        - name: deterministicOutboundIP
          value: []
        - name: outboundIPs
          value:
            - string
        - name: privateEndpointConnections
          value:
            - - name: properties
                value:
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: []
                      - name: description
                        value: string
                      - name: actionsRequired
                        value: string
                  - name: groupIds
                    value:
                      - string
                  - name: provisioningState
                    value: []
              - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
              - name: systemData
                value:
                  - name: createdBy
                    value: string
                  - name: createdByType
                    value: string
                  - name: createdAt
                    value: string
                  - name: lastModifiedBy
                    value: string
                  - name: lastModifiedByType
                    value: string
                  - name: lastModifiedAt
                    value: string
        - name: autoGeneratedDomainNameLabelScope
          value: []
        - name: grafanaIntegrations
          value:
            - name: azureMonitorWorkspaceIntegrations
              value:
                - - name: azureMonitorWorkspaceResourceId
                    value: string
        - name: enterpriseConfigurations
          value:
            - name: marketplacePlanId
              value: string
            - name: marketplaceAutoRenew
              value: []
        - name: grafanaConfigurations
          value:
            - name: smtp
              value:
                - name: enabled
                  value: boolean
                - name: host
                  value: string
                - name: user
                  value: string
                - name: password
                  value: string
                - name: fromAddress
                  value: string
                - name: fromName
                  value: string
                - name: startTLSPolicy
                  value: []
                - name: skipVerify
                  value: boolean
        - name: grafanaPlugins
          value: object
        - name: grafanaMajorVersion
          value: string
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: []
        - name: userAssignedIdentities
          value: []
    - name: tags
      value: object
    - name: location
      value: string

UPDATE example

Updates a grafana resource.

/*+ update */
UPDATE azure.dashboard.grafana
SET 
sku = '{{ sku }}',
identity = '{{ identity }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';

DELETE example

Deletes the specified grafana resource.

/*+ delete */
DELETE FROM azure.dashboard.grafana
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND workspaceName = '{{ workspaceName }}';