We recommend using Azure Native.
azure.dashboard.Grafana
Explore with Pulumi AI
Manages a Dashboard Grafana.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "example-resources",
location: "West Europe",
});
const exampleGrafana = new azure.dashboard.Grafana("example", {
name: "example-dg",
resourceGroupName: example.name,
location: "West Europe",
grafanaMajorVersion: "10",
apiKeyEnabled: true,
deterministicOutboundIpEnabled: true,
publicNetworkAccessEnabled: false,
identity: {
type: "SystemAssigned",
},
tags: {
key: "value",
},
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="example-resources",
location="West Europe")
example_grafana = azure.dashboard.Grafana("example",
name="example-dg",
resource_group_name=example.name,
location="West Europe",
grafana_major_version="10",
api_key_enabled=True,
deterministic_outbound_ip_enabled=True,
public_network_access_enabled=False,
identity={
"type": "SystemAssigned",
},
tags={
"key": "value",
})
package main
import (
"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
"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 := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
Name: pulumi.String("example-resources"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
_, err = dashboard.NewGrafana(ctx, "example", &dashboard.GrafanaArgs{
Name: pulumi.String("example-dg"),
ResourceGroupName: example.Name,
Location: pulumi.String("West Europe"),
GrafanaMajorVersion: pulumi.String("10"),
ApiKeyEnabled: pulumi.Bool(true),
DeterministicOutboundIpEnabled: pulumi.Bool(true),
PublicNetworkAccessEnabled: pulumi.Bool(false),
Identity: &dashboard.GrafanaIdentityArgs{
Type: pulumi.String("SystemAssigned"),
},
Tags: pulumi.StringMap{
"key": pulumi.String("value"),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "example-resources",
Location = "West Europe",
});
var exampleGrafana = new Azure.Dashboard.Grafana("example", new()
{
Name = "example-dg",
ResourceGroupName = example.Name,
Location = "West Europe",
GrafanaMajorVersion = "10",
ApiKeyEnabled = true,
DeterministicOutboundIpEnabled = true,
PublicNetworkAccessEnabled = false,
Identity = new Azure.Dashboard.Inputs.GrafanaIdentityArgs
{
Type = "SystemAssigned",
},
Tags =
{
{ "key", "value" },
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.dashboard.Grafana;
import com.pulumi.azure.dashboard.GrafanaArgs;
import com.pulumi.azure.dashboard.inputs.GrafanaIdentityArgs;
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) {
var example = new ResourceGroup("example", ResourceGroupArgs.builder()
.name("example-resources")
.location("West Europe")
.build());
var exampleGrafana = new Grafana("exampleGrafana", GrafanaArgs.builder()
.name("example-dg")
.resourceGroupName(example.name())
.location("West Europe")
.grafanaMajorVersion(10)
.apiKeyEnabled(true)
.deterministicOutboundIpEnabled(true)
.publicNetworkAccessEnabled(false)
.identity(GrafanaIdentityArgs.builder()
.type("SystemAssigned")
.build())
.tags(Map.of("key", "value"))
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: example-resources
location: West Europe
exampleGrafana:
type: azure:dashboard:Grafana
name: example
properties:
name: example-dg
resourceGroupName: ${example.name}
location: West Europe
grafanaMajorVersion: 10
apiKeyEnabled: true
deterministicOutboundIpEnabled: true
publicNetworkAccessEnabled: false
identity:
type: SystemAssigned
tags:
key: value
Create Grafana Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Grafana(name: string, args: GrafanaArgs, opts?: CustomResourceOptions);
@overload
def Grafana(resource_name: str,
args: GrafanaArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Grafana(resource_name: str,
opts: Optional[ResourceOptions] = None,
grafana_major_version: Optional[str] = None,
resource_group_name: Optional[str] = None,
deterministic_outbound_ip_enabled: Optional[bool] = None,
api_key_enabled: Optional[bool] = None,
azure_monitor_workspace_integrations: Optional[Sequence[GrafanaAzureMonitorWorkspaceIntegrationArgs]] = None,
identity: Optional[GrafanaIdentityArgs] = None,
location: Optional[str] = None,
name: Optional[str] = None,
public_network_access_enabled: Optional[bool] = None,
auto_generated_domain_name_label_scope: Optional[str] = None,
sku: Optional[str] = None,
smtp: Optional[GrafanaSmtpArgs] = None,
tags: Optional[Mapping[str, str]] = None,
zone_redundancy_enabled: Optional[bool] = None)
func NewGrafana(ctx *Context, name string, args GrafanaArgs, opts ...ResourceOption) (*Grafana, error)
public Grafana(string name, GrafanaArgs args, CustomResourceOptions? opts = null)
public Grafana(String name, GrafanaArgs args)
public Grafana(String name, GrafanaArgs args, CustomResourceOptions options)
type: azure:dashboard:Grafana
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args GrafanaArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GrafanaArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GrafanaArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GrafanaArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GrafanaArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var grafanaResource = new Azure.Dashboard.Grafana("grafanaResource", new()
{
GrafanaMajorVersion = "string",
ResourceGroupName = "string",
DeterministicOutboundIpEnabled = false,
ApiKeyEnabled = false,
AzureMonitorWorkspaceIntegrations = new[]
{
new Azure.Dashboard.Inputs.GrafanaAzureMonitorWorkspaceIntegrationArgs
{
ResourceId = "string",
},
},
Identity = new Azure.Dashboard.Inputs.GrafanaIdentityArgs
{
Type = "string",
IdentityIds = new[]
{
"string",
},
PrincipalId = "string",
TenantId = "string",
},
Location = "string",
Name = "string",
PublicNetworkAccessEnabled = false,
AutoGeneratedDomainNameLabelScope = "string",
Sku = "string",
Smtp = new Azure.Dashboard.Inputs.GrafanaSmtpArgs
{
FromAddress = "string",
Host = "string",
Password = "string",
StartTlsPolicy = "string",
User = "string",
Enabled = false,
FromName = "string",
VerificationSkipEnabled = false,
},
Tags =
{
{ "string", "string" },
},
ZoneRedundancyEnabled = false,
});
example, err := dashboard.NewGrafana(ctx, "grafanaResource", &dashboard.GrafanaArgs{
GrafanaMajorVersion: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
DeterministicOutboundIpEnabled: pulumi.Bool(false),
ApiKeyEnabled: pulumi.Bool(false),
AzureMonitorWorkspaceIntegrations: dashboard.GrafanaAzureMonitorWorkspaceIntegrationArray{
&dashboard.GrafanaAzureMonitorWorkspaceIntegrationArgs{
ResourceId: pulumi.String("string"),
},
},
Identity: &dashboard.GrafanaIdentityArgs{
Type: pulumi.String("string"),
IdentityIds: pulumi.StringArray{
pulumi.String("string"),
},
PrincipalId: pulumi.String("string"),
TenantId: pulumi.String("string"),
},
Location: pulumi.String("string"),
Name: pulumi.String("string"),
PublicNetworkAccessEnabled: pulumi.Bool(false),
AutoGeneratedDomainNameLabelScope: pulumi.String("string"),
Sku: pulumi.String("string"),
Smtp: &dashboard.GrafanaSmtpArgs{
FromAddress: pulumi.String("string"),
Host: pulumi.String("string"),
Password: pulumi.String("string"),
StartTlsPolicy: pulumi.String("string"),
User: pulumi.String("string"),
Enabled: pulumi.Bool(false),
FromName: pulumi.String("string"),
VerificationSkipEnabled: pulumi.Bool(false),
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
ZoneRedundancyEnabled: pulumi.Bool(false),
})
var grafanaResource = new Grafana("grafanaResource", GrafanaArgs.builder()
.grafanaMajorVersion("string")
.resourceGroupName("string")
.deterministicOutboundIpEnabled(false)
.apiKeyEnabled(false)
.azureMonitorWorkspaceIntegrations(GrafanaAzureMonitorWorkspaceIntegrationArgs.builder()
.resourceId("string")
.build())
.identity(GrafanaIdentityArgs.builder()
.type("string")
.identityIds("string")
.principalId("string")
.tenantId("string")
.build())
.location("string")
.name("string")
.publicNetworkAccessEnabled(false)
.autoGeneratedDomainNameLabelScope("string")
.sku("string")
.smtp(GrafanaSmtpArgs.builder()
.fromAddress("string")
.host("string")
.password("string")
.startTlsPolicy("string")
.user("string")
.enabled(false)
.fromName("string")
.verificationSkipEnabled(false)
.build())
.tags(Map.of("string", "string"))
.zoneRedundancyEnabled(false)
.build());
grafana_resource = azure.dashboard.Grafana("grafanaResource",
grafana_major_version="string",
resource_group_name="string",
deterministic_outbound_ip_enabled=False,
api_key_enabled=False,
azure_monitor_workspace_integrations=[{
"resourceId": "string",
}],
identity={
"type": "string",
"identityIds": ["string"],
"principalId": "string",
"tenantId": "string",
},
location="string",
name="string",
public_network_access_enabled=False,
auto_generated_domain_name_label_scope="string",
sku="string",
smtp={
"fromAddress": "string",
"host": "string",
"password": "string",
"startTlsPolicy": "string",
"user": "string",
"enabled": False,
"fromName": "string",
"verificationSkipEnabled": False,
},
tags={
"string": "string",
},
zone_redundancy_enabled=False)
const grafanaResource = new azure.dashboard.Grafana("grafanaResource", {
grafanaMajorVersion: "string",
resourceGroupName: "string",
deterministicOutboundIpEnabled: false,
apiKeyEnabled: false,
azureMonitorWorkspaceIntegrations: [{
resourceId: "string",
}],
identity: {
type: "string",
identityIds: ["string"],
principalId: "string",
tenantId: "string",
},
location: "string",
name: "string",
publicNetworkAccessEnabled: false,
autoGeneratedDomainNameLabelScope: "string",
sku: "string",
smtp: {
fromAddress: "string",
host: "string",
password: "string",
startTlsPolicy: "string",
user: "string",
enabled: false,
fromName: "string",
verificationSkipEnabled: false,
},
tags: {
string: "string",
},
zoneRedundancyEnabled: false,
});
type: azure:dashboard:Grafana
properties:
apiKeyEnabled: false
autoGeneratedDomainNameLabelScope: string
azureMonitorWorkspaceIntegrations:
- resourceId: string
deterministicOutboundIpEnabled: false
grafanaMajorVersion: string
identity:
identityIds:
- string
principalId: string
tenantId: string
type: string
location: string
name: string
publicNetworkAccessEnabled: false
resourceGroupName: string
sku: string
smtp:
enabled: false
fromAddress: string
fromName: string
host: string
password: string
startTlsPolicy: string
user: string
verificationSkipEnabled: false
tags:
string: string
zoneRedundancyEnabled: false
Grafana Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Grafana resource accepts the following input properties:
- Grafana
Major stringVersion - Which major version of Grafana to deploy. Possible values are
9
,10
. Changing this forces a new resource to be created. - Resource
Group stringName - Specifies the name of the Resource Group where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- Api
Key boolEnabled - Whether to enable the api key setting of the Grafana instance. Defaults to
false
. - Auto
Generated stringDomain Name Label Scope - Scope for dns deterministic name hash calculation. The only possible value is
TenantReuse
. Defaults toTenantReuse
. - Azure
Monitor List<GrafanaWorkspace Integrations Azure Monitor Workspace Integration> - A
azure_monitor_workspace_integrations
block as defined below. - Deterministic
Outbound boolIp Enabled - Whether to enable the Grafana instance to use deterministic outbound IPs. Defaults to
false
. - Identity
Grafana
Identity - An
identity
block as defined below. Changing this forces a new Dashboard Grafana to be created. - Location string
- Specifies the Azure Region where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- Name string
- Specifies the name which should be used for this Dashboard Grafana. Changing this forces a new Dashboard Grafana to be created.
- Public
Network boolAccess Enabled - Whether to enable traffic over the public interface. Defaults to
true
. - Sku string
- The name of the SKU used for the Grafana instance. Possible values are
Standard
andEssential
. Defaults toStandard
. Changing this forces a new Dashboard Grafana to be created. - Smtp
Grafana
Smtp - A
smtp
block as defined below. - Dictionary<string, string>
- A mapping of tags which should be assigned to the Dashboard Grafana.
- Zone
Redundancy boolEnabled - Whether to enable the zone redundancy setting of the Grafana instance. Defaults to
false
. Changing this forces a new Dashboard Grafana to be created.
- Grafana
Major stringVersion - Which major version of Grafana to deploy. Possible values are
9
,10
. Changing this forces a new resource to be created. - Resource
Group stringName - Specifies the name of the Resource Group where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- Api
Key boolEnabled - Whether to enable the api key setting of the Grafana instance. Defaults to
false
. - Auto
Generated stringDomain Name Label Scope - Scope for dns deterministic name hash calculation. The only possible value is
TenantReuse
. Defaults toTenantReuse
. - Azure
Monitor []GrafanaWorkspace Integrations Azure Monitor Workspace Integration Args - A
azure_monitor_workspace_integrations
block as defined below. - Deterministic
Outbound boolIp Enabled - Whether to enable the Grafana instance to use deterministic outbound IPs. Defaults to
false
. - Identity
Grafana
Identity Args - An
identity
block as defined below. Changing this forces a new Dashboard Grafana to be created. - Location string
- Specifies the Azure Region where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- Name string
- Specifies the name which should be used for this Dashboard Grafana. Changing this forces a new Dashboard Grafana to be created.
- Public
Network boolAccess Enabled - Whether to enable traffic over the public interface. Defaults to
true
. - Sku string
- The name of the SKU used for the Grafana instance. Possible values are
Standard
andEssential
. Defaults toStandard
. Changing this forces a new Dashboard Grafana to be created. - Smtp
Grafana
Smtp Args - A
smtp
block as defined below. - map[string]string
- A mapping of tags which should be assigned to the Dashboard Grafana.
- Zone
Redundancy boolEnabled - Whether to enable the zone redundancy setting of the Grafana instance. Defaults to
false
. Changing this forces a new Dashboard Grafana to be created.
- grafana
Major StringVersion - Which major version of Grafana to deploy. Possible values are
9
,10
. Changing this forces a new resource to be created. - resource
Group StringName - Specifies the name of the Resource Group where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- api
Key BooleanEnabled - Whether to enable the api key setting of the Grafana instance. Defaults to
false
. - auto
Generated StringDomain Name Label Scope - Scope for dns deterministic name hash calculation. The only possible value is
TenantReuse
. Defaults toTenantReuse
. - azure
Monitor List<GrafanaWorkspace Integrations Azure Monitor Workspace Integration> - A
azure_monitor_workspace_integrations
block as defined below. - deterministic
Outbound BooleanIp Enabled - Whether to enable the Grafana instance to use deterministic outbound IPs. Defaults to
false
. - identity
Grafana
Identity - An
identity
block as defined below. Changing this forces a new Dashboard Grafana to be created. - location String
- Specifies the Azure Region where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- name String
- Specifies the name which should be used for this Dashboard Grafana. Changing this forces a new Dashboard Grafana to be created.
- public
Network BooleanAccess Enabled - Whether to enable traffic over the public interface. Defaults to
true
. - sku String
- The name of the SKU used for the Grafana instance. Possible values are
Standard
andEssential
. Defaults toStandard
. Changing this forces a new Dashboard Grafana to be created. - smtp
Grafana
Smtp - A
smtp
block as defined below. - Map<String,String>
- A mapping of tags which should be assigned to the Dashboard Grafana.
- zone
Redundancy BooleanEnabled - Whether to enable the zone redundancy setting of the Grafana instance. Defaults to
false
. Changing this forces a new Dashboard Grafana to be created.
- grafana
Major stringVersion - Which major version of Grafana to deploy. Possible values are
9
,10
. Changing this forces a new resource to be created. - resource
Group stringName - Specifies the name of the Resource Group where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- api
Key booleanEnabled - Whether to enable the api key setting of the Grafana instance. Defaults to
false
. - auto
Generated stringDomain Name Label Scope - Scope for dns deterministic name hash calculation. The only possible value is
TenantReuse
. Defaults toTenantReuse
. - azure
Monitor GrafanaWorkspace Integrations Azure Monitor Workspace Integration[] - A
azure_monitor_workspace_integrations
block as defined below. - deterministic
Outbound booleanIp Enabled - Whether to enable the Grafana instance to use deterministic outbound IPs. Defaults to
false
. - identity
Grafana
Identity - An
identity
block as defined below. Changing this forces a new Dashboard Grafana to be created. - location string
- Specifies the Azure Region where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- name string
- Specifies the name which should be used for this Dashboard Grafana. Changing this forces a new Dashboard Grafana to be created.
- public
Network booleanAccess Enabled - Whether to enable traffic over the public interface. Defaults to
true
. - sku string
- The name of the SKU used for the Grafana instance. Possible values are
Standard
andEssential
. Defaults toStandard
. Changing this forces a new Dashboard Grafana to be created. - smtp
Grafana
Smtp - A
smtp
block as defined below. - {[key: string]: string}
- A mapping of tags which should be assigned to the Dashboard Grafana.
- zone
Redundancy booleanEnabled - Whether to enable the zone redundancy setting of the Grafana instance. Defaults to
false
. Changing this forces a new Dashboard Grafana to be created.
- grafana_
major_ strversion - Which major version of Grafana to deploy. Possible values are
9
,10
. Changing this forces a new resource to be created. - resource_
group_ strname - Specifies the name of the Resource Group where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- api_
key_ boolenabled - Whether to enable the api key setting of the Grafana instance. Defaults to
false
. - auto_
generated_ strdomain_ name_ label_ scope - Scope for dns deterministic name hash calculation. The only possible value is
TenantReuse
. Defaults toTenantReuse
. - azure_
monitor_ Sequence[Grafanaworkspace_ integrations Azure Monitor Workspace Integration Args] - A
azure_monitor_workspace_integrations
block as defined below. - deterministic_
outbound_ boolip_ enabled - Whether to enable the Grafana instance to use deterministic outbound IPs. Defaults to
false
. - identity
Grafana
Identity Args - An
identity
block as defined below. Changing this forces a new Dashboard Grafana to be created. - location str
- Specifies the Azure Region where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- name str
- Specifies the name which should be used for this Dashboard Grafana. Changing this forces a new Dashboard Grafana to be created.
- public_
network_ boolaccess_ enabled - Whether to enable traffic over the public interface. Defaults to
true
. - sku str
- The name of the SKU used for the Grafana instance. Possible values are
Standard
andEssential
. Defaults toStandard
. Changing this forces a new Dashboard Grafana to be created. - smtp
Grafana
Smtp Args - A
smtp
block as defined below. - Mapping[str, str]
- A mapping of tags which should be assigned to the Dashboard Grafana.
- zone_
redundancy_ boolenabled - Whether to enable the zone redundancy setting of the Grafana instance. Defaults to
false
. Changing this forces a new Dashboard Grafana to be created.
- grafana
Major StringVersion - Which major version of Grafana to deploy. Possible values are
9
,10
. Changing this forces a new resource to be created. - resource
Group StringName - Specifies the name of the Resource Group where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- api
Key BooleanEnabled - Whether to enable the api key setting of the Grafana instance. Defaults to
false
. - auto
Generated StringDomain Name Label Scope - Scope for dns deterministic name hash calculation. The only possible value is
TenantReuse
. Defaults toTenantReuse
. - azure
Monitor List<Property Map>Workspace Integrations - A
azure_monitor_workspace_integrations
block as defined below. - deterministic
Outbound BooleanIp Enabled - Whether to enable the Grafana instance to use deterministic outbound IPs. Defaults to
false
. - identity Property Map
- An
identity
block as defined below. Changing this forces a new Dashboard Grafana to be created. - location String
- Specifies the Azure Region where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- name String
- Specifies the name which should be used for this Dashboard Grafana. Changing this forces a new Dashboard Grafana to be created.
- public
Network BooleanAccess Enabled - Whether to enable traffic over the public interface. Defaults to
true
. - sku String
- The name of the SKU used for the Grafana instance. Possible values are
Standard
andEssential
. Defaults toStandard
. Changing this forces a new Dashboard Grafana to be created. - smtp Property Map
- A
smtp
block as defined below. - Map<String>
- A mapping of tags which should be assigned to the Dashboard Grafana.
- zone
Redundancy BooleanEnabled - Whether to enable the zone redundancy setting of the Grafana instance. Defaults to
false
. Changing this forces a new Dashboard Grafana to be created.
Outputs
All input properties are implicitly available as output properties. Additionally, the Grafana resource produces the following output properties:
- Endpoint string
- The endpoint of the Grafana instance.
- string
- The full Grafana software semantic version deployed.
- Id string
- The provider-assigned unique ID for this managed resource.
- Outbound
Ips List<string> - List of outbound IPs if deterministicOutboundIP is enabled.
- Endpoint string
- The endpoint of the Grafana instance.
- string
- The full Grafana software semantic version deployed.
- Id string
- The provider-assigned unique ID for this managed resource.
- Outbound
Ips []string - List of outbound IPs if deterministicOutboundIP is enabled.
- endpoint String
- The endpoint of the Grafana instance.
- String
- The full Grafana software semantic version deployed.
- id String
- The provider-assigned unique ID for this managed resource.
- outbound
Ips List<String> - List of outbound IPs if deterministicOutboundIP is enabled.
- endpoint string
- The endpoint of the Grafana instance.
- string
- The full Grafana software semantic version deployed.
- id string
- The provider-assigned unique ID for this managed resource.
- outbound
Ips string[] - List of outbound IPs if deterministicOutboundIP is enabled.
- endpoint str
- The endpoint of the Grafana instance.
- grafana_
version str - The full Grafana software semantic version deployed.
- id str
- The provider-assigned unique ID for this managed resource.
- outbound_
ips Sequence[str] - List of outbound IPs if deterministicOutboundIP is enabled.
- endpoint String
- The endpoint of the Grafana instance.
- String
- The full Grafana software semantic version deployed.
- id String
- The provider-assigned unique ID for this managed resource.
- outbound
Ips List<String> - List of outbound IPs if deterministicOutboundIP is enabled.
Look up Existing Grafana Resource
Get an existing Grafana resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: GrafanaState, opts?: CustomResourceOptions): Grafana
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
api_key_enabled: Optional[bool] = None,
auto_generated_domain_name_label_scope: Optional[str] = None,
azure_monitor_workspace_integrations: Optional[Sequence[GrafanaAzureMonitorWorkspaceIntegrationArgs]] = None,
deterministic_outbound_ip_enabled: Optional[bool] = None,
endpoint: Optional[str] = None,
grafana_major_version: Optional[str] = None,
grafana_version: Optional[str] = None,
identity: Optional[GrafanaIdentityArgs] = None,
location: Optional[str] = None,
name: Optional[str] = None,
outbound_ips: Optional[Sequence[str]] = None,
public_network_access_enabled: Optional[bool] = None,
resource_group_name: Optional[str] = None,
sku: Optional[str] = None,
smtp: Optional[GrafanaSmtpArgs] = None,
tags: Optional[Mapping[str, str]] = None,
zone_redundancy_enabled: Optional[bool] = None) -> Grafana
func GetGrafana(ctx *Context, name string, id IDInput, state *GrafanaState, opts ...ResourceOption) (*Grafana, error)
public static Grafana Get(string name, Input<string> id, GrafanaState? state, CustomResourceOptions? opts = null)
public static Grafana get(String name, Output<String> id, GrafanaState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Api
Key boolEnabled - Whether to enable the api key setting of the Grafana instance. Defaults to
false
. - Auto
Generated stringDomain Name Label Scope - Scope for dns deterministic name hash calculation. The only possible value is
TenantReuse
. Defaults toTenantReuse
. - Azure
Monitor List<GrafanaWorkspace Integrations Azure Monitor Workspace Integration> - A
azure_monitor_workspace_integrations
block as defined below. - Deterministic
Outbound boolIp Enabled - Whether to enable the Grafana instance to use deterministic outbound IPs. Defaults to
false
. - Endpoint string
- The endpoint of the Grafana instance.
- Grafana
Major stringVersion - Which major version of Grafana to deploy. Possible values are
9
,10
. Changing this forces a new resource to be created. - string
- The full Grafana software semantic version deployed.
- Identity
Grafana
Identity - An
identity
block as defined below. Changing this forces a new Dashboard Grafana to be created. - Location string
- Specifies the Azure Region where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- Name string
- Specifies the name which should be used for this Dashboard Grafana. Changing this forces a new Dashboard Grafana to be created.
- Outbound
Ips List<string> - List of outbound IPs if deterministicOutboundIP is enabled.
- Public
Network boolAccess Enabled - Whether to enable traffic over the public interface. Defaults to
true
. - Resource
Group stringName - Specifies the name of the Resource Group where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- Sku string
- The name of the SKU used for the Grafana instance. Possible values are
Standard
andEssential
. Defaults toStandard
. Changing this forces a new Dashboard Grafana to be created. - Smtp
Grafana
Smtp - A
smtp
block as defined below. - Dictionary<string, string>
- A mapping of tags which should be assigned to the Dashboard Grafana.
- Zone
Redundancy boolEnabled - Whether to enable the zone redundancy setting of the Grafana instance. Defaults to
false
. Changing this forces a new Dashboard Grafana to be created.
- Api
Key boolEnabled - Whether to enable the api key setting of the Grafana instance. Defaults to
false
. - Auto
Generated stringDomain Name Label Scope - Scope for dns deterministic name hash calculation. The only possible value is
TenantReuse
. Defaults toTenantReuse
. - Azure
Monitor []GrafanaWorkspace Integrations Azure Monitor Workspace Integration Args - A
azure_monitor_workspace_integrations
block as defined below. - Deterministic
Outbound boolIp Enabled - Whether to enable the Grafana instance to use deterministic outbound IPs. Defaults to
false
. - Endpoint string
- The endpoint of the Grafana instance.
- Grafana
Major stringVersion - Which major version of Grafana to deploy. Possible values are
9
,10
. Changing this forces a new resource to be created. - string
- The full Grafana software semantic version deployed.
- Identity
Grafana
Identity Args - An
identity
block as defined below. Changing this forces a new Dashboard Grafana to be created. - Location string
- Specifies the Azure Region where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- Name string
- Specifies the name which should be used for this Dashboard Grafana. Changing this forces a new Dashboard Grafana to be created.
- Outbound
Ips []string - List of outbound IPs if deterministicOutboundIP is enabled.
- Public
Network boolAccess Enabled - Whether to enable traffic over the public interface. Defaults to
true
. - Resource
Group stringName - Specifies the name of the Resource Group where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- Sku string
- The name of the SKU used for the Grafana instance. Possible values are
Standard
andEssential
. Defaults toStandard
. Changing this forces a new Dashboard Grafana to be created. - Smtp
Grafana
Smtp Args - A
smtp
block as defined below. - map[string]string
- A mapping of tags which should be assigned to the Dashboard Grafana.
- Zone
Redundancy boolEnabled - Whether to enable the zone redundancy setting of the Grafana instance. Defaults to
false
. Changing this forces a new Dashboard Grafana to be created.
- api
Key BooleanEnabled - Whether to enable the api key setting of the Grafana instance. Defaults to
false
. - auto
Generated StringDomain Name Label Scope - Scope for dns deterministic name hash calculation. The only possible value is
TenantReuse
. Defaults toTenantReuse
. - azure
Monitor List<GrafanaWorkspace Integrations Azure Monitor Workspace Integration> - A
azure_monitor_workspace_integrations
block as defined below. - deterministic
Outbound BooleanIp Enabled - Whether to enable the Grafana instance to use deterministic outbound IPs. Defaults to
false
. - endpoint String
- The endpoint of the Grafana instance.
- grafana
Major StringVersion - Which major version of Grafana to deploy. Possible values are
9
,10
. Changing this forces a new resource to be created. - String
- The full Grafana software semantic version deployed.
- identity
Grafana
Identity - An
identity
block as defined below. Changing this forces a new Dashboard Grafana to be created. - location String
- Specifies the Azure Region where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- name String
- Specifies the name which should be used for this Dashboard Grafana. Changing this forces a new Dashboard Grafana to be created.
- outbound
Ips List<String> - List of outbound IPs if deterministicOutboundIP is enabled.
- public
Network BooleanAccess Enabled - Whether to enable traffic over the public interface. Defaults to
true
. - resource
Group StringName - Specifies the name of the Resource Group where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- sku String
- The name of the SKU used for the Grafana instance. Possible values are
Standard
andEssential
. Defaults toStandard
. Changing this forces a new Dashboard Grafana to be created. - smtp
Grafana
Smtp - A
smtp
block as defined below. - Map<String,String>
- A mapping of tags which should be assigned to the Dashboard Grafana.
- zone
Redundancy BooleanEnabled - Whether to enable the zone redundancy setting of the Grafana instance. Defaults to
false
. Changing this forces a new Dashboard Grafana to be created.
- api
Key booleanEnabled - Whether to enable the api key setting of the Grafana instance. Defaults to
false
. - auto
Generated stringDomain Name Label Scope - Scope for dns deterministic name hash calculation. The only possible value is
TenantReuse
. Defaults toTenantReuse
. - azure
Monitor GrafanaWorkspace Integrations Azure Monitor Workspace Integration[] - A
azure_monitor_workspace_integrations
block as defined below. - deterministic
Outbound booleanIp Enabled - Whether to enable the Grafana instance to use deterministic outbound IPs. Defaults to
false
. - endpoint string
- The endpoint of the Grafana instance.
- grafana
Major stringVersion - Which major version of Grafana to deploy. Possible values are
9
,10
. Changing this forces a new resource to be created. - string
- The full Grafana software semantic version deployed.
- identity
Grafana
Identity - An
identity
block as defined below. Changing this forces a new Dashboard Grafana to be created. - location string
- Specifies the Azure Region where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- name string
- Specifies the name which should be used for this Dashboard Grafana. Changing this forces a new Dashboard Grafana to be created.
- outbound
Ips string[] - List of outbound IPs if deterministicOutboundIP is enabled.
- public
Network booleanAccess Enabled - Whether to enable traffic over the public interface. Defaults to
true
. - resource
Group stringName - Specifies the name of the Resource Group where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- sku string
- The name of the SKU used for the Grafana instance. Possible values are
Standard
andEssential
. Defaults toStandard
. Changing this forces a new Dashboard Grafana to be created. - smtp
Grafana
Smtp - A
smtp
block as defined below. - {[key: string]: string}
- A mapping of tags which should be assigned to the Dashboard Grafana.
- zone
Redundancy booleanEnabled - Whether to enable the zone redundancy setting of the Grafana instance. Defaults to
false
. Changing this forces a new Dashboard Grafana to be created.
- api_
key_ boolenabled - Whether to enable the api key setting of the Grafana instance. Defaults to
false
. - auto_
generated_ strdomain_ name_ label_ scope - Scope for dns deterministic name hash calculation. The only possible value is
TenantReuse
. Defaults toTenantReuse
. - azure_
monitor_ Sequence[Grafanaworkspace_ integrations Azure Monitor Workspace Integration Args] - A
azure_monitor_workspace_integrations
block as defined below. - deterministic_
outbound_ boolip_ enabled - Whether to enable the Grafana instance to use deterministic outbound IPs. Defaults to
false
. - endpoint str
- The endpoint of the Grafana instance.
- grafana_
major_ strversion - Which major version of Grafana to deploy. Possible values are
9
,10
. Changing this forces a new resource to be created. - grafana_
version str - The full Grafana software semantic version deployed.
- identity
Grafana
Identity Args - An
identity
block as defined below. Changing this forces a new Dashboard Grafana to be created. - location str
- Specifies the Azure Region where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- name str
- Specifies the name which should be used for this Dashboard Grafana. Changing this forces a new Dashboard Grafana to be created.
- outbound_
ips Sequence[str] - List of outbound IPs if deterministicOutboundIP is enabled.
- public_
network_ boolaccess_ enabled - Whether to enable traffic over the public interface. Defaults to
true
. - resource_
group_ strname - Specifies the name of the Resource Group where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- sku str
- The name of the SKU used for the Grafana instance. Possible values are
Standard
andEssential
. Defaults toStandard
. Changing this forces a new Dashboard Grafana to be created. - smtp
Grafana
Smtp Args - A
smtp
block as defined below. - Mapping[str, str]
- A mapping of tags which should be assigned to the Dashboard Grafana.
- zone_
redundancy_ boolenabled - Whether to enable the zone redundancy setting of the Grafana instance. Defaults to
false
. Changing this forces a new Dashboard Grafana to be created.
- api
Key BooleanEnabled - Whether to enable the api key setting of the Grafana instance. Defaults to
false
. - auto
Generated StringDomain Name Label Scope - Scope for dns deterministic name hash calculation. The only possible value is
TenantReuse
. Defaults toTenantReuse
. - azure
Monitor List<Property Map>Workspace Integrations - A
azure_monitor_workspace_integrations
block as defined below. - deterministic
Outbound BooleanIp Enabled - Whether to enable the Grafana instance to use deterministic outbound IPs. Defaults to
false
. - endpoint String
- The endpoint of the Grafana instance.
- grafana
Major StringVersion - Which major version of Grafana to deploy. Possible values are
9
,10
. Changing this forces a new resource to be created. - String
- The full Grafana software semantic version deployed.
- identity Property Map
- An
identity
block as defined below. Changing this forces a new Dashboard Grafana to be created. - location String
- Specifies the Azure Region where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- name String
- Specifies the name which should be used for this Dashboard Grafana. Changing this forces a new Dashboard Grafana to be created.
- outbound
Ips List<String> - List of outbound IPs if deterministicOutboundIP is enabled.
- public
Network BooleanAccess Enabled - Whether to enable traffic over the public interface. Defaults to
true
. - resource
Group StringName - Specifies the name of the Resource Group where the Dashboard Grafana should exist. Changing this forces a new Dashboard Grafana to be created.
- sku String
- The name of the SKU used for the Grafana instance. Possible values are
Standard
andEssential
. Defaults toStandard
. Changing this forces a new Dashboard Grafana to be created. - smtp Property Map
- A
smtp
block as defined below. - Map<String>
- A mapping of tags which should be assigned to the Dashboard Grafana.
- zone
Redundancy BooleanEnabled - Whether to enable the zone redundancy setting of the Grafana instance. Defaults to
false
. Changing this forces a new Dashboard Grafana to be created.
Supporting Types
GrafanaAzureMonitorWorkspaceIntegration, GrafanaAzureMonitorWorkspaceIntegrationArgs
- Resource
Id string - Specifies the resource ID of the connected Azure Monitor Workspace.
- Resource
Id string - Specifies the resource ID of the connected Azure Monitor Workspace.
- resource
Id String - Specifies the resource ID of the connected Azure Monitor Workspace.
- resource
Id string - Specifies the resource ID of the connected Azure Monitor Workspace.
- resource_
id str - Specifies the resource ID of the connected Azure Monitor Workspace.
- resource
Id String - Specifies the resource ID of the connected Azure Monitor Workspace.
GrafanaIdentity, GrafanaIdentityArgs
- Type string
- Specifies the type of Managed Service Identity. Possible values are
SystemAssigned
,UserAssigned
. Changing this forces a new resource to be created. - Identity
Ids List<string> - Specifies the list of User Assigned Managed Service Identity IDs which should be assigned to this Dashboard Grafana. Changing this forces a new resource to be created.
- Principal
Id string - The Principal ID associated with this Managed Service Identity.
- Tenant
Id string - The Tenant ID associated with this Managed Service Identity.
- Type string
- Specifies the type of Managed Service Identity. Possible values are
SystemAssigned
,UserAssigned
. Changing this forces a new resource to be created. - Identity
Ids []string - Specifies the list of User Assigned Managed Service Identity IDs which should be assigned to this Dashboard Grafana. Changing this forces a new resource to be created.
- Principal
Id string - The Principal ID associated with this Managed Service Identity.
- Tenant
Id string - The Tenant ID associated with this Managed Service Identity.
- type String
- Specifies the type of Managed Service Identity. Possible values are
SystemAssigned
,UserAssigned
. Changing this forces a new resource to be created. - identity
Ids List<String> - Specifies the list of User Assigned Managed Service Identity IDs which should be assigned to this Dashboard Grafana. Changing this forces a new resource to be created.
- principal
Id String - The Principal ID associated with this Managed Service Identity.
- tenant
Id String - The Tenant ID associated with this Managed Service Identity.
- type string
- Specifies the type of Managed Service Identity. Possible values are
SystemAssigned
,UserAssigned
. Changing this forces a new resource to be created. - identity
Ids string[] - Specifies the list of User Assigned Managed Service Identity IDs which should be assigned to this Dashboard Grafana. Changing this forces a new resource to be created.
- principal
Id string - The Principal ID associated with this Managed Service Identity.
- tenant
Id string - The Tenant ID associated with this Managed Service Identity.
- type str
- Specifies the type of Managed Service Identity. Possible values are
SystemAssigned
,UserAssigned
. Changing this forces a new resource to be created. - identity_
ids Sequence[str] - Specifies the list of User Assigned Managed Service Identity IDs which should be assigned to this Dashboard Grafana. Changing this forces a new resource to be created.
- principal_
id str - The Principal ID associated with this Managed Service Identity.
- tenant_
id str - The Tenant ID associated with this Managed Service Identity.
- type String
- Specifies the type of Managed Service Identity. Possible values are
SystemAssigned
,UserAssigned
. Changing this forces a new resource to be created. - identity
Ids List<String> - Specifies the list of User Assigned Managed Service Identity IDs which should be assigned to this Dashboard Grafana. Changing this forces a new resource to be created.
- principal
Id String - The Principal ID associated with this Managed Service Identity.
- tenant
Id String - The Tenant ID associated with this Managed Service Identity.
GrafanaSmtp, GrafanaSmtpArgs
- From
Address string - Address used when sending emails.
- Host string
- SMTP server hostname with port, e.g. test.email.net:587
- Password string
- Password of SMTP authentication.
- Start
Tls stringPolicy - Whether to use TLS when connecting to SMTP server. Possible values are
OpportunisticStartTLS
,NoStartTLS
,MandatoryStartTLS
. - User string
- User of SMTP authentication.
- Enabled bool
- Whether to enable the smtp setting of the Grafana instance. Defaults to
false
. - From
Name string - Name used when sending emails. Defaults to
Azure Managed Grafana Notification
. - Verification
Skip boolEnabled - Whether verify SSL for SMTP server. Defaults to
false
.
- From
Address string - Address used when sending emails.
- Host string
- SMTP server hostname with port, e.g. test.email.net:587
- Password string
- Password of SMTP authentication.
- Start
Tls stringPolicy - Whether to use TLS when connecting to SMTP server. Possible values are
OpportunisticStartTLS
,NoStartTLS
,MandatoryStartTLS
. - User string
- User of SMTP authentication.
- Enabled bool
- Whether to enable the smtp setting of the Grafana instance. Defaults to
false
. - From
Name string - Name used when sending emails. Defaults to
Azure Managed Grafana Notification
. - Verification
Skip boolEnabled - Whether verify SSL for SMTP server. Defaults to
false
.
- from
Address String - Address used when sending emails.
- host String
- SMTP server hostname with port, e.g. test.email.net:587
- password String
- Password of SMTP authentication.
- start
Tls StringPolicy - Whether to use TLS when connecting to SMTP server. Possible values are
OpportunisticStartTLS
,NoStartTLS
,MandatoryStartTLS
. - user String
- User of SMTP authentication.
- enabled Boolean
- Whether to enable the smtp setting of the Grafana instance. Defaults to
false
. - from
Name String - Name used when sending emails. Defaults to
Azure Managed Grafana Notification
. - verification
Skip BooleanEnabled - Whether verify SSL for SMTP server. Defaults to
false
.
- from
Address string - Address used when sending emails.
- host string
- SMTP server hostname with port, e.g. test.email.net:587
- password string
- Password of SMTP authentication.
- start
Tls stringPolicy - Whether to use TLS when connecting to SMTP server. Possible values are
OpportunisticStartTLS
,NoStartTLS
,MandatoryStartTLS
. - user string
- User of SMTP authentication.
- enabled boolean
- Whether to enable the smtp setting of the Grafana instance. Defaults to
false
. - from
Name string - Name used when sending emails. Defaults to
Azure Managed Grafana Notification
. - verification
Skip booleanEnabled - Whether verify SSL for SMTP server. Defaults to
false
.
- from_
address str - Address used when sending emails.
- host str
- SMTP server hostname with port, e.g. test.email.net:587
- password str
- Password of SMTP authentication.
- start_
tls_ strpolicy - Whether to use TLS when connecting to SMTP server. Possible values are
OpportunisticStartTLS
,NoStartTLS
,MandatoryStartTLS
. - user str
- User of SMTP authentication.
- enabled bool
- Whether to enable the smtp setting of the Grafana instance. Defaults to
false
. - from_
name str - Name used when sending emails. Defaults to
Azure Managed Grafana Notification
. - verification_
skip_ boolenabled - Whether verify SSL for SMTP server. Defaults to
false
.
- from
Address String - Address used when sending emails.
- host String
- SMTP server hostname with port, e.g. test.email.net:587
- password String
- Password of SMTP authentication.
- start
Tls StringPolicy - Whether to use TLS when connecting to SMTP server. Possible values are
OpportunisticStartTLS
,NoStartTLS
,MandatoryStartTLS
. - user String
- User of SMTP authentication.
- enabled Boolean
- Whether to enable the smtp setting of the Grafana instance. Defaults to
false
. - from
Name String - Name used when sending emails. Defaults to
Azure Managed Grafana Notification
. - verification
Skip BooleanEnabled - Whether verify SSL for SMTP server. Defaults to
false
.
Import
Dashboard Grafana can be imported using the resource id
, e.g.
$ pulumi import azure:dashboard/grafana:Grafana example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/resourceGroup1/providers/Microsoft.Dashboard/grafana/workspace1
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.