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

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.
apiKey	string	The api key setting of the Grafana instance. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
autoGeneratedDomainNameLabelScope	string	Scope for dns deterministic name hash calculation. "TenantReuse" (TenantReuse)
creatorCanAdmin	string	The creator will have admin access for the Grafana instance. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
deterministicOutboundIP	string	Whether a Grafana instance uses deterministic outbound IPs. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
endpoint	string	The endpoint of the Grafana instance.
enterpriseConfigurations	object	Enterprise settings of a Grafana instance.
grafanaConfigurations	object	Server configurations of a Grafana instance.
grafanaIntegrations	object	GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios.
grafanaMajorVersion	string	The major Grafana software version to target.
grafanaPlugins	object	Installed plugin list of the Grafana instance. Key is plugin id, value is plugin definition.
grafanaVersion	string	The Grafana software version.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives.
outboundIPs	array	List of outbound IPs if deterministicOutboundIP is enabled.
privateEndpointConnections	array	The private endpoint connections of the Grafana instance.
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)
publicNetworkAccess	string	Indicate the state for enable or disable traffic over the public interface. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
sku	object	The Sku of the grafana resource.
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".
zoneRedundancy	string	The zone redundancy setting of the Grafana instance. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)

list_by_resource_group

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.
apiKey	string	The api key setting of the Grafana instance. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
autoGeneratedDomainNameLabelScope	string	Scope for dns deterministic name hash calculation. "TenantReuse" (TenantReuse)
creatorCanAdmin	string	The creator will have admin access for the Grafana instance. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
deterministicOutboundIP	string	Whether a Grafana instance uses deterministic outbound IPs. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
endpoint	string	The endpoint of the Grafana instance.
enterpriseConfigurations	object	Enterprise settings of a Grafana instance.
grafanaConfigurations	object	Server configurations of a Grafana instance.
grafanaIntegrations	object	GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios.
grafanaMajorVersion	string	The major Grafana software version to target.
grafanaPlugins	object	Installed plugin list of the Grafana instance. Key is plugin id, value is plugin definition.
grafanaVersion	string	The Grafana software version.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives.
outboundIPs	array	List of outbound IPs if deterministicOutboundIP is enabled.
privateEndpointConnections	array	The private endpoint connections of the Grafana instance.
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)
publicNetworkAccess	string	Indicate the state for enable or disable traffic over the public interface. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
sku	object	The Sku of the grafana resource.
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".
zoneRedundancy	string	The zone redundancy setting of the Grafana instance. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)

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.
apiKey	string	The api key setting of the Grafana instance. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
autoGeneratedDomainNameLabelScope	string	Scope for dns deterministic name hash calculation. "TenantReuse" (TenantReuse)
creatorCanAdmin	string	The creator will have admin access for the Grafana instance. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
deterministicOutboundIP	string	Whether a Grafana instance uses deterministic outbound IPs. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)
endpoint	string	The endpoint of the Grafana instance.
enterpriseConfigurations	object	Enterprise settings of a Grafana instance.
grafanaConfigurations	object	Server configurations of a Grafana instance.
grafanaIntegrations	object	GrafanaIntegrations is a bundled observability experience (e.g. pre-configured data source, tailored Grafana dashboards, alerting defaults) for common monitoring scenarios.
grafanaMajorVersion	string	The major Grafana software version to target.
grafanaPlugins	object	Installed plugin list of the Grafana instance. Key is plugin id, value is plugin definition.
grafanaVersion	string	The Grafana software version.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives.
outboundIPs	array	List of outbound IPs if deterministicOutboundIP is enabled.
privateEndpointConnections	array	The private endpoint connections of the Grafana instance.
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)
publicNetworkAccess	string	Indicate the state for enable or disable traffic over the public interface. Known values are: "Enabled" and "Disabled". (Enabled, Disabled)
sku	object	The Sku of the grafana resource.
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".
zoneRedundancy	string	The zone redundancy setting of the Grafana instance. Known values are: "Disabled" and "Enabled". (Disabled, Enabled)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, workspace_name, subscription_id		Get the properties of a specific workspace for Grafana resource.
list_by_resource_group	select	resource_group_name, subscription_id		List all resources of workspaces for Grafana under the specified resource group.
list	select	subscription_id		List all resources of workspaces for Grafana under the specified subscription.
create	insert	resource_group_name, workspace_name, subscription_id		Create or update a workspace for Grafana resource. This API is idempotent, so user can either create a new grafana or update an existing grafana.
update	update	resource_group_name, workspace_name, subscription_id		Update a workspace for Grafana resource.
delete	delete	resource_group_name, workspace_name, subscription_id		Delete a workspace for Grafana resource.
check_enterprise_details	exec	resource_group_name, workspace_name, subscription_id		Retrieve enterprise add-on details information.
fetch_available_plugins	exec	resource_group_name, workspace_name, subscription_id		A synchronous resource action.

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

SELECT examples

get

Get the properties of a specific workspace for Grafana resource.

SELECT
id,
name,
apiKey,
autoGeneratedDomainNameLabelScope,
creatorCanAdmin,
deterministicOutboundIP,
endpoint,
enterpriseConfigurations,
grafanaConfigurations,
grafanaIntegrations,
grafanaMajorVersion,
grafanaPlugins,
grafanaVersion,
identity,
location,
outboundIPs,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
type,
zoneRedundancy
FROM azure.dashboard.grafana
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND workspace_name = '{{ workspace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List all resources of workspaces for Grafana under the specified resource group.

SELECT
id,
name,
apiKey,
autoGeneratedDomainNameLabelScope,
creatorCanAdmin,
deterministicOutboundIP,
endpoint,
enterpriseConfigurations,
grafanaConfigurations,
grafanaIntegrations,
grafanaMajorVersion,
grafanaPlugins,
grafanaVersion,
identity,
location,
outboundIPs,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
type,
zoneRedundancy
FROM azure.dashboard.grafana
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all resources of workspaces for Grafana under the specified subscription.

SELECT
id,
name,
apiKey,
autoGeneratedDomainNameLabelScope,
creatorCanAdmin,
deterministicOutboundIP,
endpoint,
enterpriseConfigurations,
grafanaConfigurations,
grafanaIntegrations,
grafanaMajorVersion,
grafanaPlugins,
grafanaVersion,
identity,
location,
outboundIPs,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
type,
zoneRedundancy
FROM azure.dashboard.grafana
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

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

INSERT INTO azure.dashboard.grafana (
properties,
sku,
tags,
location,
identity,
resource_group_name,
workspace_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ sku }}',
'{{ tags }}',
'{{ location }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ workspace_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: grafana
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the grafana resource.
  - name: workspace_name
    value: "{{ workspace_name }}"
    description: Required parameter for the grafana resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the grafana resource.
  - name: properties
    description: |
      Properties specific to the grafana resource.
    value:
      provisioningState: "{{ provisioningState }}"
      grafanaVersion: "{{ grafanaVersion }}"
      endpoint: "{{ endpoint }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      zoneRedundancy: "{{ zoneRedundancy }}"
      apiKey: "{{ apiKey }}"
      creatorCanAdmin: "{{ creatorCanAdmin }}"
      deterministicOutboundIP: "{{ deterministicOutboundIP }}"
      outboundIPs:
        - "{{ outboundIPs }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            privateEndpoint:
              id: "{{ id }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            groupIds:
              - "{{ groupIds }}"
            provisioningState: "{{ provisioningState }}"
      autoGeneratedDomainNameLabelScope: "{{ autoGeneratedDomainNameLabelScope }}"
      grafanaIntegrations:
        azureMonitorWorkspaceIntegrations:
          - azureMonitorWorkspaceResourceId: "{{ azureMonitorWorkspaceResourceId }}"
      enterpriseConfigurations:
        marketplacePlanId: "{{ marketplacePlanId }}"
        marketplaceAutoRenew: "{{ marketplaceAutoRenew }}"
      grafanaConfigurations:
        smtp:
          enabled: {{ enabled }}
          host: "{{ host }}"
          user: "{{ user }}"
          password: "{{ password }}"
          fromAddress: "{{ fromAddress }}"
          fromName: "{{ fromName }}"
          startTLSPolicy: "{{ startTLSPolicy }}"
          skipVerify: {{ skipVerify }}
        snapshots:
          externalEnabled: {{ externalEnabled }}
        users:
          viewersCanEdit: {{ viewersCanEdit }}
          editorsCanAdmin: {{ editorsCanAdmin }}
        security:
          csrfAlwaysCheck: {{ csrfAlwaysCheck }}
        unifiedAlertingScreenshots:
          captureEnabled: {{ captureEnabled }}
      grafanaPlugins: "{{ grafanaPlugins }}"
      grafanaMajorVersion: "{{ grafanaMajorVersion }}"
  - name: sku
    description: |
      The Sku of the grafana resource.
    value:
      name: "{{ name }}"
      size: "{{ size }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives.
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update a workspace for Grafana resource.

UPDATE azure.dashboard.grafana
SET 
sku = '{{ sku }}',
identity = '{{ identity }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND workspace_name = '{{ workspace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Delete a workspace for Grafana resource.

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

Lifecycle Methods

check_enterprise_details

Retrieve enterprise add-on details information.

EXEC azure.dashboard.grafana.check_enterprise_details 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

fetch_available_plugins

A synchronous resource action.

EXEC azure.dashboard.grafana.fetch_available_plugins 
@resource_group_name='{{ resource_group_name }}' --required, 
@workspace_name='{{ workspace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;