1. Packages
  2. Azure Classic
  3. API Docs
  4. dashboard
  5. getGrafana

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

azure.dashboard.getGrafana

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi

Use this data source to access information about an existing Grafana Dashboard.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const example = azure.dashboard.getGrafana({
    name: "example-grafana-dashboard",
    resourceGroupName: "example-rg",
});
export const name = example.then(example => example.name);
Copy
import pulumi
import pulumi_azure as azure

example = azure.dashboard.get_grafana(name="example-grafana-dashboard",
    resource_group_name="example-rg")
pulumi.export("name", example.name)
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/dashboard"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := dashboard.LookupGrafana(ctx, &dashboard.LookupGrafanaArgs{
			Name:              "example-grafana-dashboard",
			ResourceGroupName: "example-rg",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("name", example.Name)
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var example = Azure.Dashboard.GetGrafana.Invoke(new()
    {
        Name = "example-grafana-dashboard",
        ResourceGroupName = "example-rg",
    });

    return new Dictionary<string, object?>
    {
        ["name"] = example.Apply(getGrafanaResult => getGrafanaResult.Name),
    };
});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.dashboard.DashboardFunctions;
import com.pulumi.azure.dashboard.inputs.GetGrafanaArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var example = DashboardFunctions.getGrafana(GetGrafanaArgs.builder()
            .name("example-grafana-dashboard")
            .resourceGroupName("example-rg")
            .build());

        ctx.export("name", example.applyValue(getGrafanaResult -> getGrafanaResult.name()));
    }
}
Copy
variables:
  example:
    fn::invoke:
      function: azure:dashboard:getGrafana
      arguments:
        name: example-grafana-dashboard
        resourceGroupName: example-rg
outputs:
  name: ${example.name}
Copy

Using getGrafana

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGrafana(args: GetGrafanaArgs, opts?: InvokeOptions): Promise<GetGrafanaResult>
function getGrafanaOutput(args: GetGrafanaOutputArgs, opts?: InvokeOptions): Output<GetGrafanaResult>
Copy
def get_grafana(identity: Optional[GetGrafanaIdentity] = None,
                name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetGrafanaResult
def get_grafana_output(identity: Optional[pulumi.Input[GetGrafanaIdentityArgs]] = None,
                name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetGrafanaResult]
Copy
func LookupGrafana(ctx *Context, args *LookupGrafanaArgs, opts ...InvokeOption) (*LookupGrafanaResult, error)
func LookupGrafanaOutput(ctx *Context, args *LookupGrafanaOutputArgs, opts ...InvokeOption) LookupGrafanaResultOutput
Copy

> Note: This function is named LookupGrafana in the Go SDK.

public static class GetGrafana 
{
    public static Task<GetGrafanaResult> InvokeAsync(GetGrafanaArgs args, InvokeOptions? opts = null)
    public static Output<GetGrafanaResult> Invoke(GetGrafanaInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetGrafanaResult> getGrafana(GetGrafanaArgs args, InvokeOptions options)
public static Output<GetGrafanaResult> getGrafana(GetGrafanaArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure:dashboard/getGrafana:getGrafana
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Name of the grafana dashboard.
ResourceGroupName This property is required. string
Name of the resource group where resource belongs to.
Identity Changes to this property will trigger replacement. GetGrafanaIdentity
The managed identity of the grafana resource.
Name This property is required. string
Name of the grafana dashboard.
ResourceGroupName This property is required. string
Name of the resource group where resource belongs to.
Identity Changes to this property will trigger replacement. GetGrafanaIdentity
The managed identity of the grafana resource.
name This property is required. String
Name of the grafana dashboard.
resourceGroupName This property is required. String
Name of the resource group where resource belongs to.
identity Changes to this property will trigger replacement. GetGrafanaIdentity
The managed identity of the grafana resource.
name This property is required. string
Name of the grafana dashboard.
resourceGroupName This property is required. string
Name of the resource group where resource belongs to.
identity Changes to this property will trigger replacement. GetGrafanaIdentity
The managed identity of the grafana resource.
name This property is required. str
Name of the grafana dashboard.
resource_group_name This property is required. str
Name of the resource group where resource belongs to.
identity Changes to this property will trigger replacement. GetGrafanaIdentity
The managed identity of the grafana resource.
name This property is required. String
Name of the grafana dashboard.
resourceGroupName This property is required. String
Name of the resource group where resource belongs to.
identity Changes to this property will trigger replacement. Property Map
The managed identity of the grafana resource.

getGrafana Result

The following output properties are available:

ApiKeyEnabled bool
Whether the api key setting of the Grafana instance is enabled.
AutoGeneratedDomainNameLabelScope string
Scope for dns deterministic name hash calculation.
AzureMonitorWorkspaceIntegrations List<GetGrafanaAzureMonitorWorkspaceIntegration>
Integrations for Azure Monitor Workspace.
DeterministicOutboundIpEnabled bool
Whether the Grafana instance uses deterministic outbound IPs.
Endpoint string
The endpoint of the Grafana instance.
GrafanaMajorVersion string
Major version of Grafana instance.
GrafanaVersion string
The full Grafana software semantic version deployed.
Id string
The provider-assigned unique ID for this managed resource.
Location string
Azure location where the resource exists.
Name string
OutboundIps List<string>
PublicNetworkAccessEnabled bool
Whether or not public endpoint access is allowed for this server.
ResourceGroupName string
Sku string
The name of the SKU used for the Grafana instance.
Tags Dictionary<string, string>
A mapping of tags to assigned to the resource.
ZoneRedundancyEnabled bool
The zone redundancy setting of the Grafana instance.
Identity GetGrafanaIdentity
The managed identity of the grafana resource.
ApiKeyEnabled bool
Whether the api key setting of the Grafana instance is enabled.
AutoGeneratedDomainNameLabelScope string
Scope for dns deterministic name hash calculation.
AzureMonitorWorkspaceIntegrations []GetGrafanaAzureMonitorWorkspaceIntegration
Integrations for Azure Monitor Workspace.
DeterministicOutboundIpEnabled bool
Whether the Grafana instance uses deterministic outbound IPs.
Endpoint string
The endpoint of the Grafana instance.
GrafanaMajorVersion string
Major version of Grafana instance.
GrafanaVersion string
The full Grafana software semantic version deployed.
Id string
The provider-assigned unique ID for this managed resource.
Location string
Azure location where the resource exists.
Name string
OutboundIps []string
PublicNetworkAccessEnabled bool
Whether or not public endpoint access is allowed for this server.
ResourceGroupName string
Sku string
The name of the SKU used for the Grafana instance.
Tags map[string]string
A mapping of tags to assigned to the resource.
ZoneRedundancyEnabled bool
The zone redundancy setting of the Grafana instance.
Identity GetGrafanaIdentity
The managed identity of the grafana resource.
apiKeyEnabled Boolean
Whether the api key setting of the Grafana instance is enabled.
autoGeneratedDomainNameLabelScope String
Scope for dns deterministic name hash calculation.
azureMonitorWorkspaceIntegrations List<GetGrafanaAzureMonitorWorkspaceIntegration>
Integrations for Azure Monitor Workspace.
deterministicOutboundIpEnabled Boolean
Whether the Grafana instance uses deterministic outbound IPs.
endpoint String
The endpoint of the Grafana instance.
grafanaMajorVersion String
Major version of Grafana instance.
grafanaVersion String
The full Grafana software semantic version deployed.
id String
The provider-assigned unique ID for this managed resource.
location String
Azure location where the resource exists.
name String
outboundIps List<String>
publicNetworkAccessEnabled Boolean
Whether or not public endpoint access is allowed for this server.
resourceGroupName String
sku String
The name of the SKU used for the Grafana instance.
tags Map<String,String>
A mapping of tags to assigned to the resource.
zoneRedundancyEnabled Boolean
The zone redundancy setting of the Grafana instance.
identity GetGrafanaIdentity
The managed identity of the grafana resource.
apiKeyEnabled boolean
Whether the api key setting of the Grafana instance is enabled.
autoGeneratedDomainNameLabelScope string
Scope for dns deterministic name hash calculation.
azureMonitorWorkspaceIntegrations GetGrafanaAzureMonitorWorkspaceIntegration[]
Integrations for Azure Monitor Workspace.
deterministicOutboundIpEnabled boolean
Whether the Grafana instance uses deterministic outbound IPs.
endpoint string
The endpoint of the Grafana instance.
grafanaMajorVersion string
Major version of Grafana instance.
grafanaVersion string
The full Grafana software semantic version deployed.
id string
The provider-assigned unique ID for this managed resource.
location string
Azure location where the resource exists.
name string
outboundIps string[]
publicNetworkAccessEnabled boolean
Whether or not public endpoint access is allowed for this server.
resourceGroupName string
sku string
The name of the SKU used for the Grafana instance.
tags {[key: string]: string}
A mapping of tags to assigned to the resource.
zoneRedundancyEnabled boolean
The zone redundancy setting of the Grafana instance.
identity GetGrafanaIdentity
The managed identity of the grafana resource.
api_key_enabled bool
Whether the api key setting of the Grafana instance is enabled.
auto_generated_domain_name_label_scope str
Scope for dns deterministic name hash calculation.
azure_monitor_workspace_integrations Sequence[GetGrafanaAzureMonitorWorkspaceIntegration]
Integrations for Azure Monitor Workspace.
deterministic_outbound_ip_enabled bool
Whether the Grafana instance uses deterministic outbound IPs.
endpoint str
The endpoint of the Grafana instance.
grafana_major_version str
Major version of Grafana instance.
grafana_version str
The full Grafana software semantic version deployed.
id str
The provider-assigned unique ID for this managed resource.
location str
Azure location where the resource exists.
name str
outbound_ips Sequence[str]
public_network_access_enabled bool
Whether or not public endpoint access is allowed for this server.
resource_group_name str
sku str
The name of the SKU used for the Grafana instance.
tags Mapping[str, str]
A mapping of tags to assigned to the resource.
zone_redundancy_enabled bool
The zone redundancy setting of the Grafana instance.
identity GetGrafanaIdentity
The managed identity of the grafana resource.
apiKeyEnabled Boolean
Whether the api key setting of the Grafana instance is enabled.
autoGeneratedDomainNameLabelScope String
Scope for dns deterministic name hash calculation.
azureMonitorWorkspaceIntegrations List<Property Map>
Integrations for Azure Monitor Workspace.
deterministicOutboundIpEnabled Boolean
Whether the Grafana instance uses deterministic outbound IPs.
endpoint String
The endpoint of the Grafana instance.
grafanaMajorVersion String
Major version of Grafana instance.
grafanaVersion String
The full Grafana software semantic version deployed.
id String
The provider-assigned unique ID for this managed resource.
location String
Azure location where the resource exists.
name String
outboundIps List<String>
publicNetworkAccessEnabled Boolean
Whether or not public endpoint access is allowed for this server.
resourceGroupName String
sku String
The name of the SKU used for the Grafana instance.
tags Map<String>
A mapping of tags to assigned to the resource.
zoneRedundancyEnabled Boolean
The zone redundancy setting of the Grafana instance.
identity Property Map
The managed identity of the grafana resource.

Supporting Types

GetGrafanaAzureMonitorWorkspaceIntegration

ResourceId This property is required. string
ResourceId This property is required. string
resourceId This property is required. String
resourceId This property is required. string
resource_id This property is required. str
resourceId This property is required. String

GetGrafanaIdentity

PrincipalId This property is required. string
TenantId This property is required. string
Type This property is required. string
IdentityIds List<string>
PrincipalId This property is required. string
TenantId This property is required. string
Type This property is required. string
IdentityIds []string
principalId This property is required. String
tenantId This property is required. String
type This property is required. String
identityIds List<String>
principalId This property is required. string
tenantId This property is required. string
type This property is required. string
identityIds string[]
principal_id This property is required. str
tenant_id This property is required. str
type This property is required. str
identity_ids Sequence[str]
principalId This property is required. String
tenantId This property is required. String
type This property is required. String
identityIds List<String>

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi