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

We recommend using Azure Native.

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

azure.dashboard.GrafanaManagedPrivateEndpoint

Explore with Pulumi AI

Manages a Dashboard Grafana Managed Private Endpoint.

NOTE: This resource will not approve the managed private endpoint connection on the linked resource. This will need to be done manually via Azure CLI, PowerShell, or AzAPI resources. See here for an example that uses AzAPI.

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: "Canada Central",
});
const exampleWorkspace = new azure.monitoring.Workspace("example", {
    name: "example-mamw",
    resourceGroupName: example.name,
    location: example.location,
    publicNetworkAccessEnabled: false,
});
const exampleGrafana = new azure.dashboard.Grafana("example", {
    name: "example-dg",
    resourceGroupName: example.name,
    location: example.location,
    grafanaMajorVersion: "11",
    publicNetworkAccessEnabled: false,
    azureMonitorWorkspaceIntegrations: [{
        resourceId: exampleWorkspace.id,
    }],
});
const exampleGrafanaManagedPrivateEndpoint = new azure.dashboard.GrafanaManagedPrivateEndpoint("example", {
    grafanaId: exampleGrafana.id,
    name: "example-mpe",
    location: exampleGrafana.location,
    privateLinkResourceId: exampleWorkspace.id,
    groupIds: ["prometheusMetrics"],
    privateLinkResourceRegion: exampleGrafana.location,
});
Copy
import pulumi
import pulumi_azure as azure

example = azure.core.ResourceGroup("example",
    name="example-resources",
    location="Canada Central")
example_workspace = azure.monitoring.Workspace("example",
    name="example-mamw",
    resource_group_name=example.name,
    location=example.location,
    public_network_access_enabled=False)
example_grafana = azure.dashboard.Grafana("example",
    name="example-dg",
    resource_group_name=example.name,
    location=example.location,
    grafana_major_version="11",
    public_network_access_enabled=False,
    azure_monitor_workspace_integrations=[{
        "resource_id": example_workspace.id,
    }])
example_grafana_managed_private_endpoint = azure.dashboard.GrafanaManagedPrivateEndpoint("example",
    grafana_id=example_grafana.id,
    name="example-mpe",
    location=example_grafana.location,
    private_link_resource_id=example_workspace.id,
    group_ids=["prometheusMetrics"],
    private_link_resource_region=example_grafana.location)
Copy
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-azure/sdk/v6/go/azure/monitoring"
	"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("Canada Central"),
		})
		if err != nil {
			return err
		}
		exampleWorkspace, err := monitoring.NewWorkspace(ctx, "example", &monitoring.WorkspaceArgs{
			Name:                       pulumi.String("example-mamw"),
			ResourceGroupName:          example.Name,
			Location:                   example.Location,
			PublicNetworkAccessEnabled: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		exampleGrafana, err := dashboard.NewGrafana(ctx, "example", &dashboard.GrafanaArgs{
			Name:                       pulumi.String("example-dg"),
			ResourceGroupName:          example.Name,
			Location:                   example.Location,
			GrafanaMajorVersion:        pulumi.String("11"),
			PublicNetworkAccessEnabled: pulumi.Bool(false),
			AzureMonitorWorkspaceIntegrations: dashboard.GrafanaAzureMonitorWorkspaceIntegrationArray{
				&dashboard.GrafanaAzureMonitorWorkspaceIntegrationArgs{
					ResourceId: exampleWorkspace.ID(),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = dashboard.NewGrafanaManagedPrivateEndpoint(ctx, "example", &dashboard.GrafanaManagedPrivateEndpointArgs{
			GrafanaId:             exampleGrafana.ID(),
			Name:                  pulumi.String("example-mpe"),
			Location:              exampleGrafana.Location,
			PrivateLinkResourceId: exampleWorkspace.ID(),
			GroupIds: pulumi.StringArray{
				pulumi.String("prometheusMetrics"),
			},
			PrivateLinkResourceRegion: exampleGrafana.Location,
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 = "Canada Central",
    });

    var exampleWorkspace = new Azure.Monitoring.Workspace("example", new()
    {
        Name = "example-mamw",
        ResourceGroupName = example.Name,
        Location = example.Location,
        PublicNetworkAccessEnabled = false,
    });

    var exampleGrafana = new Azure.Dashboard.Grafana("example", new()
    {
        Name = "example-dg",
        ResourceGroupName = example.Name,
        Location = example.Location,
        GrafanaMajorVersion = "11",
        PublicNetworkAccessEnabled = false,
        AzureMonitorWorkspaceIntegrations = new[]
        {
            new Azure.Dashboard.Inputs.GrafanaAzureMonitorWorkspaceIntegrationArgs
            {
                ResourceId = exampleWorkspace.Id,
            },
        },
    });

    var exampleGrafanaManagedPrivateEndpoint = new Azure.Dashboard.GrafanaManagedPrivateEndpoint("example", new()
    {
        GrafanaId = exampleGrafana.Id,
        Name = "example-mpe",
        Location = exampleGrafana.Location,
        PrivateLinkResourceId = exampleWorkspace.Id,
        GroupIds = new[]
        {
            "prometheusMetrics",
        },
        PrivateLinkResourceRegion = exampleGrafana.Location,
    });

});
Copy
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.monitoring.Workspace;
import com.pulumi.azure.monitoring.WorkspaceArgs;
import com.pulumi.azure.dashboard.Grafana;
import com.pulumi.azure.dashboard.GrafanaArgs;
import com.pulumi.azure.dashboard.inputs.GrafanaAzureMonitorWorkspaceIntegrationArgs;
import com.pulumi.azure.dashboard.GrafanaManagedPrivateEndpoint;
import com.pulumi.azure.dashboard.GrafanaManagedPrivateEndpointArgs;
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("Canada Central")
            .build());

        var exampleWorkspace = new Workspace("exampleWorkspace", WorkspaceArgs.builder()
            .name("example-mamw")
            .resourceGroupName(example.name())
            .location(example.location())
            .publicNetworkAccessEnabled(false)
            .build());

        var exampleGrafana = new Grafana("exampleGrafana", GrafanaArgs.builder()
            .name("example-dg")
            .resourceGroupName(example.name())
            .location(example.location())
            .grafanaMajorVersion(11)
            .publicNetworkAccessEnabled(false)
            .azureMonitorWorkspaceIntegrations(GrafanaAzureMonitorWorkspaceIntegrationArgs.builder()
                .resourceId(exampleWorkspace.id())
                .build())
            .build());

        var exampleGrafanaManagedPrivateEndpoint = new GrafanaManagedPrivateEndpoint("exampleGrafanaManagedPrivateEndpoint", GrafanaManagedPrivateEndpointArgs.builder()
            .grafanaId(exampleGrafana.id())
            .name("example-mpe")
            .location(exampleGrafana.location())
            .privateLinkResourceId(exampleWorkspace.id())
            .groupIds("prometheusMetrics")
            .privateLinkResourceRegion(exampleGrafana.location())
            .build());

    }
}
Copy
resources:
  example:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: Canada Central
  exampleWorkspace:
    type: azure:monitoring:Workspace
    name: example
    properties:
      name: example-mamw
      resourceGroupName: ${example.name}
      location: ${example.location}
      publicNetworkAccessEnabled: false
  exampleGrafana:
    type: azure:dashboard:Grafana
    name: example
    properties:
      name: example-dg
      resourceGroupName: ${example.name}
      location: ${example.location}
      grafanaMajorVersion: 11
      publicNetworkAccessEnabled: false
      azureMonitorWorkspaceIntegrations:
        - resourceId: ${exampleWorkspace.id}
  exampleGrafanaManagedPrivateEndpoint:
    type: azure:dashboard:GrafanaManagedPrivateEndpoint
    name: example
    properties:
      grafanaId: ${exampleGrafana.id}
      name: example-mpe
      location: ${exampleGrafana.location}
      privateLinkResourceId: ${exampleWorkspace.id}
      groupIds:
        - prometheusMetrics
      privateLinkResourceRegion: ${exampleGrafana.location}
Copy

Create GrafanaManagedPrivateEndpoint Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new GrafanaManagedPrivateEndpoint(name: string, args: GrafanaManagedPrivateEndpointArgs, opts?: CustomResourceOptions);
@overload
def GrafanaManagedPrivateEndpoint(resource_name: str,
                                  args: GrafanaManagedPrivateEndpointArgs,
                                  opts: Optional[ResourceOptions] = None)

@overload
def GrafanaManagedPrivateEndpoint(resource_name: str,
                                  opts: Optional[ResourceOptions] = None,
                                  grafana_id: Optional[str] = None,
                                  private_link_resource_id: Optional[str] = None,
                                  group_ids: Optional[Sequence[str]] = None,
                                  location: Optional[str] = None,
                                  name: Optional[str] = None,
                                  private_link_resource_region: Optional[str] = None,
                                  request_message: Optional[str] = None,
                                  tags: Optional[Mapping[str, str]] = None)
func NewGrafanaManagedPrivateEndpoint(ctx *Context, name string, args GrafanaManagedPrivateEndpointArgs, opts ...ResourceOption) (*GrafanaManagedPrivateEndpoint, error)
public GrafanaManagedPrivateEndpoint(string name, GrafanaManagedPrivateEndpointArgs args, CustomResourceOptions? opts = null)
public GrafanaManagedPrivateEndpoint(String name, GrafanaManagedPrivateEndpointArgs args)
public GrafanaManagedPrivateEndpoint(String name, GrafanaManagedPrivateEndpointArgs args, CustomResourceOptions options)
type: azure:dashboard:GrafanaManagedPrivateEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GrafanaManagedPrivateEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GrafanaManagedPrivateEndpointArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GrafanaManagedPrivateEndpointArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GrafanaManagedPrivateEndpointArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GrafanaManagedPrivateEndpointArgs
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 grafanaManagedPrivateEndpointResource = new Azure.Dashboard.GrafanaManagedPrivateEndpoint("grafanaManagedPrivateEndpointResource", new()
{
    GrafanaId = "string",
    PrivateLinkResourceId = "string",
    GroupIds = new[]
    {
        "string",
    },
    Location = "string",
    Name = "string",
    PrivateLinkResourceRegion = "string",
    RequestMessage = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := dashboard.NewGrafanaManagedPrivateEndpoint(ctx, "grafanaManagedPrivateEndpointResource", &dashboard.GrafanaManagedPrivateEndpointArgs{
	GrafanaId:             pulumi.String("string"),
	PrivateLinkResourceId: pulumi.String("string"),
	GroupIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	Location:                  pulumi.String("string"),
	Name:                      pulumi.String("string"),
	PrivateLinkResourceRegion: pulumi.String("string"),
	RequestMessage:            pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var grafanaManagedPrivateEndpointResource = new GrafanaManagedPrivateEndpoint("grafanaManagedPrivateEndpointResource", GrafanaManagedPrivateEndpointArgs.builder()
    .grafanaId("string")
    .privateLinkResourceId("string")
    .groupIds("string")
    .location("string")
    .name("string")
    .privateLinkResourceRegion("string")
    .requestMessage("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
grafana_managed_private_endpoint_resource = azure.dashboard.GrafanaManagedPrivateEndpoint("grafanaManagedPrivateEndpointResource",
    grafana_id="string",
    private_link_resource_id="string",
    group_ids=["string"],
    location="string",
    name="string",
    private_link_resource_region="string",
    request_message="string",
    tags={
        "string": "string",
    })
Copy
const grafanaManagedPrivateEndpointResource = new azure.dashboard.GrafanaManagedPrivateEndpoint("grafanaManagedPrivateEndpointResource", {
    grafanaId: "string",
    privateLinkResourceId: "string",
    groupIds: ["string"],
    location: "string",
    name: "string",
    privateLinkResourceRegion: "string",
    requestMessage: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure:dashboard:GrafanaManagedPrivateEndpoint
properties:
    grafanaId: string
    groupIds:
        - string
    location: string
    name: string
    privateLinkResourceId: string
    privateLinkResourceRegion: string
    requestMessage: string
    tags:
        string: string
Copy

GrafanaManagedPrivateEndpoint Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The GrafanaManagedPrivateEndpoint resource accepts the following input properties:

GrafanaId
This property is required.
Changes to this property will trigger replacement.
string
The id of the associated managed Grafana. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
PrivateLinkResourceId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the resource to which this Dashboard Grafana Managed Private Endpoint will connect. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
GroupIds Changes to this property will trigger replacement. List<string>
Specifies a list of private link group IDs. The value of this will depend on the private link resource to which you are connecting. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
Location Changes to this property will trigger replacement. string
The Azure Region where the Dashboard Grafana Managed Private Endpoint should exist. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Dashboard Grafana Managed Private Endpoint. Must be between 2 and 20 alphanumeric characters or dashes, must begin with letter and end with a letter or number. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
PrivateLinkResourceRegion Changes to this property will trigger replacement. string
The region in which to create the private link. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
RequestMessage string
A message to provide in the request which will be seen by approvers.
Tags Dictionary<string, string>
A mapping of tags which should be assigned to the Dashboard Grafana Managed Private Endpoint.
GrafanaId
This property is required.
Changes to this property will trigger replacement.
string
The id of the associated managed Grafana. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
PrivateLinkResourceId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the resource to which this Dashboard Grafana Managed Private Endpoint will connect. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
GroupIds Changes to this property will trigger replacement. []string
Specifies a list of private link group IDs. The value of this will depend on the private link resource to which you are connecting. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
Location Changes to this property will trigger replacement. string
The Azure Region where the Dashboard Grafana Managed Private Endpoint should exist. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Dashboard Grafana Managed Private Endpoint. Must be between 2 and 20 alphanumeric characters or dashes, must begin with letter and end with a letter or number. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
PrivateLinkResourceRegion Changes to this property will trigger replacement. string
The region in which to create the private link. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
RequestMessage string
A message to provide in the request which will be seen by approvers.
Tags map[string]string
A mapping of tags which should be assigned to the Dashboard Grafana Managed Private Endpoint.
grafanaId
This property is required.
Changes to this property will trigger replacement.
String
The id of the associated managed Grafana. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
privateLinkResourceId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the resource to which this Dashboard Grafana Managed Private Endpoint will connect. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
groupIds Changes to this property will trigger replacement. List<String>
Specifies a list of private link group IDs. The value of this will depend on the private link resource to which you are connecting. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
location Changes to this property will trigger replacement. String
The Azure Region where the Dashboard Grafana Managed Private Endpoint should exist. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Dashboard Grafana Managed Private Endpoint. Must be between 2 and 20 alphanumeric characters or dashes, must begin with letter and end with a letter or number. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
privateLinkResourceRegion Changes to this property will trigger replacement. String
The region in which to create the private link. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
requestMessage String
A message to provide in the request which will be seen by approvers.
tags Map<String,String>
A mapping of tags which should be assigned to the Dashboard Grafana Managed Private Endpoint.
grafanaId
This property is required.
Changes to this property will trigger replacement.
string
The id of the associated managed Grafana. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
privateLinkResourceId
This property is required.
Changes to this property will trigger replacement.
string
The ID of the resource to which this Dashboard Grafana Managed Private Endpoint will connect. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
groupIds Changes to this property will trigger replacement. string[]
Specifies a list of private link group IDs. The value of this will depend on the private link resource to which you are connecting. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
location Changes to this property will trigger replacement. string
The Azure Region where the Dashboard Grafana Managed Private Endpoint should exist. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
name Changes to this property will trigger replacement. string
The name which should be used for this Dashboard Grafana Managed Private Endpoint. Must be between 2 and 20 alphanumeric characters or dashes, must begin with letter and end with a letter or number. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
privateLinkResourceRegion Changes to this property will trigger replacement. string
The region in which to create the private link. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
requestMessage string
A message to provide in the request which will be seen by approvers.
tags {[key: string]: string}
A mapping of tags which should be assigned to the Dashboard Grafana Managed Private Endpoint.
grafana_id
This property is required.
Changes to this property will trigger replacement.
str
The id of the associated managed Grafana. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
private_link_resource_id
This property is required.
Changes to this property will trigger replacement.
str
The ID of the resource to which this Dashboard Grafana Managed Private Endpoint will connect. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
group_ids Changes to this property will trigger replacement. Sequence[str]
Specifies a list of private link group IDs. The value of this will depend on the private link resource to which you are connecting. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
location Changes to this property will trigger replacement. str
The Azure Region where the Dashboard Grafana Managed Private Endpoint should exist. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
name Changes to this property will trigger replacement. str
The name which should be used for this Dashboard Grafana Managed Private Endpoint. Must be between 2 and 20 alphanumeric characters or dashes, must begin with letter and end with a letter or number. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
private_link_resource_region Changes to this property will trigger replacement. str
The region in which to create the private link. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
request_message str
A message to provide in the request which will be seen by approvers.
tags Mapping[str, str]
A mapping of tags which should be assigned to the Dashboard Grafana Managed Private Endpoint.
grafanaId
This property is required.
Changes to this property will trigger replacement.
String
The id of the associated managed Grafana. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
privateLinkResourceId
This property is required.
Changes to this property will trigger replacement.
String
The ID of the resource to which this Dashboard Grafana Managed Private Endpoint will connect. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
groupIds Changes to this property will trigger replacement. List<String>
Specifies a list of private link group IDs. The value of this will depend on the private link resource to which you are connecting. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
location Changes to this property will trigger replacement. String
The Azure Region where the Dashboard Grafana Managed Private Endpoint should exist. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Dashboard Grafana Managed Private Endpoint. Must be between 2 and 20 alphanumeric characters or dashes, must begin with letter and end with a letter or number. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
privateLinkResourceRegion Changes to this property will trigger replacement. String
The region in which to create the private link. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
requestMessage String
A message to provide in the request which will be seen by approvers.
tags Map<String>
A mapping of tags which should be assigned to the Dashboard Grafana Managed Private Endpoint.

Outputs

All input properties are implicitly available as output properties. Additionally, the GrafanaManagedPrivateEndpoint resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing GrafanaManagedPrivateEndpoint Resource

Get an existing GrafanaManagedPrivateEndpoint 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?: GrafanaManagedPrivateEndpointState, opts?: CustomResourceOptions): GrafanaManagedPrivateEndpoint
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        grafana_id: Optional[str] = None,
        group_ids: Optional[Sequence[str]] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        private_link_resource_id: Optional[str] = None,
        private_link_resource_region: Optional[str] = None,
        request_message: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> GrafanaManagedPrivateEndpoint
func GetGrafanaManagedPrivateEndpoint(ctx *Context, name string, id IDInput, state *GrafanaManagedPrivateEndpointState, opts ...ResourceOption) (*GrafanaManagedPrivateEndpoint, error)
public static GrafanaManagedPrivateEndpoint Get(string name, Input<string> id, GrafanaManagedPrivateEndpointState? state, CustomResourceOptions? opts = null)
public static GrafanaManagedPrivateEndpoint get(String name, Output<String> id, GrafanaManagedPrivateEndpointState state, CustomResourceOptions options)
resources:  _:    type: azure:dashboard:GrafanaManagedPrivateEndpoint    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
GrafanaId Changes to this property will trigger replacement. string
The id of the associated managed Grafana. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
GroupIds Changes to this property will trigger replacement. List<string>
Specifies a list of private link group IDs. The value of this will depend on the private link resource to which you are connecting. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
Location Changes to this property will trigger replacement. string
The Azure Region where the Dashboard Grafana Managed Private Endpoint should exist. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Dashboard Grafana Managed Private Endpoint. Must be between 2 and 20 alphanumeric characters or dashes, must begin with letter and end with a letter or number. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
PrivateLinkResourceId Changes to this property will trigger replacement. string
The ID of the resource to which this Dashboard Grafana Managed Private Endpoint will connect. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
PrivateLinkResourceRegion Changes to this property will trigger replacement. string
The region in which to create the private link. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
RequestMessage string
A message to provide in the request which will be seen by approvers.
Tags Dictionary<string, string>
A mapping of tags which should be assigned to the Dashboard Grafana Managed Private Endpoint.
GrafanaId Changes to this property will trigger replacement. string
The id of the associated managed Grafana. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
GroupIds Changes to this property will trigger replacement. []string
Specifies a list of private link group IDs. The value of this will depend on the private link resource to which you are connecting. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
Location Changes to this property will trigger replacement. string
The Azure Region where the Dashboard Grafana Managed Private Endpoint should exist. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Dashboard Grafana Managed Private Endpoint. Must be between 2 and 20 alphanumeric characters or dashes, must begin with letter and end with a letter or number. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
PrivateLinkResourceId Changes to this property will trigger replacement. string
The ID of the resource to which this Dashboard Grafana Managed Private Endpoint will connect. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
PrivateLinkResourceRegion Changes to this property will trigger replacement. string
The region in which to create the private link. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
RequestMessage string
A message to provide in the request which will be seen by approvers.
Tags map[string]string
A mapping of tags which should be assigned to the Dashboard Grafana Managed Private Endpoint.
grafanaId Changes to this property will trigger replacement. String
The id of the associated managed Grafana. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
groupIds Changes to this property will trigger replacement. List<String>
Specifies a list of private link group IDs. The value of this will depend on the private link resource to which you are connecting. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
location Changes to this property will trigger replacement. String
The Azure Region where the Dashboard Grafana Managed Private Endpoint should exist. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Dashboard Grafana Managed Private Endpoint. Must be between 2 and 20 alphanumeric characters or dashes, must begin with letter and end with a letter or number. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
privateLinkResourceId Changes to this property will trigger replacement. String
The ID of the resource to which this Dashboard Grafana Managed Private Endpoint will connect. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
privateLinkResourceRegion Changes to this property will trigger replacement. String
The region in which to create the private link. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
requestMessage String
A message to provide in the request which will be seen by approvers.
tags Map<String,String>
A mapping of tags which should be assigned to the Dashboard Grafana Managed Private Endpoint.
grafanaId Changes to this property will trigger replacement. string
The id of the associated managed Grafana. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
groupIds Changes to this property will trigger replacement. string[]
Specifies a list of private link group IDs. The value of this will depend on the private link resource to which you are connecting. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
location Changes to this property will trigger replacement. string
The Azure Region where the Dashboard Grafana Managed Private Endpoint should exist. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
name Changes to this property will trigger replacement. string
The name which should be used for this Dashboard Grafana Managed Private Endpoint. Must be between 2 and 20 alphanumeric characters or dashes, must begin with letter and end with a letter or number. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
privateLinkResourceId Changes to this property will trigger replacement. string
The ID of the resource to which this Dashboard Grafana Managed Private Endpoint will connect. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
privateLinkResourceRegion Changes to this property will trigger replacement. string
The region in which to create the private link. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
requestMessage string
A message to provide in the request which will be seen by approvers.
tags {[key: string]: string}
A mapping of tags which should be assigned to the Dashboard Grafana Managed Private Endpoint.
grafana_id Changes to this property will trigger replacement. str
The id of the associated managed Grafana. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
group_ids Changes to this property will trigger replacement. Sequence[str]
Specifies a list of private link group IDs. The value of this will depend on the private link resource to which you are connecting. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
location Changes to this property will trigger replacement. str
The Azure Region where the Dashboard Grafana Managed Private Endpoint should exist. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
name Changes to this property will trigger replacement. str
The name which should be used for this Dashboard Grafana Managed Private Endpoint. Must be between 2 and 20 alphanumeric characters or dashes, must begin with letter and end with a letter or number. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
private_link_resource_id Changes to this property will trigger replacement. str
The ID of the resource to which this Dashboard Grafana Managed Private Endpoint will connect. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
private_link_resource_region Changes to this property will trigger replacement. str
The region in which to create the private link. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
request_message str
A message to provide in the request which will be seen by approvers.
tags Mapping[str, str]
A mapping of tags which should be assigned to the Dashboard Grafana Managed Private Endpoint.
grafanaId Changes to this property will trigger replacement. String
The id of the associated managed Grafana. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
groupIds Changes to this property will trigger replacement. List<String>
Specifies a list of private link group IDs. The value of this will depend on the private link resource to which you are connecting. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
location Changes to this property will trigger replacement. String
The Azure Region where the Dashboard Grafana Managed Private Endpoint should exist. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Dashboard Grafana Managed Private Endpoint. Must be between 2 and 20 alphanumeric characters or dashes, must begin with letter and end with a letter or number. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
privateLinkResourceId Changes to this property will trigger replacement. String
The ID of the resource to which this Dashboard Grafana Managed Private Endpoint will connect. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
privateLinkResourceRegion Changes to this property will trigger replacement. String
The region in which to create the private link. Changing this forces a new Dashboard Grafana Managed Private Endpoint to be created.
requestMessage String
A message to provide in the request which will be seen by approvers.
tags Map<String>
A mapping of tags which should be assigned to the Dashboard Grafana Managed Private Endpoint.

Import

Dashboard Grafana Managed Private Endpoint Examples can be imported using the resource id, e.g.

$ pulumi import azure:dashboard/grafanaManagedPrivateEndpoint:GrafanaManagedPrivateEndpoint example /subscriptions/12345678-1234-9876-4563-123456789012/resourceGroups/resGroup1/providers/Microsoft.Dashboard/grafana/workspace1/managedPrivateEndpoints/endpoint1
Copy

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.