Share via


Microsoft.Dashboard grafana/managedPrivateEndpoints

Bicep resource definition

The grafana/managedPrivateEndpoints resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Dashboard/grafana/managedPrivateEndpoints resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Dashboard/grafana/managedPrivateEndpoints@2024-11-01-preview' = {
  parent: resourceSymbolicName
  location: 'string'
  name: 'string'
  properties: {
    groupIds: [
      'string'
    ]
    privateLinkResourceId: 'string'
    privateLinkResourceRegion: 'string'
    privateLinkServiceUrl: 'string'
    requestMessage: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Dashboard/grafana/managedPrivateEndpoints

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.
Symbolic name for resource of type: grafana
properties Resource properties. ManagedPrivateEndpointModelProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

ManagedPrivateEndpointModelProperties

Name Description Value
groupIds The group Ids of the managed private endpoint. string[]
privateLinkResourceId The ARM resource ID of the resource for which the managed private endpoint is pointing to. string
privateLinkResourceRegion The region of the resource to which the managed private endpoint is pointing to. string
privateLinkServiceUrl The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port. string
requestMessage User input request message of the managed private endpoint. string

TrackedResourceTags

Name Description Value

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
Create AKS with Prometheus and Grafana with privae link This will create an Azure grafana, AKS and install Prometheus, an open-source monitoring and alerting toolkit, on an Azure Kubernetes Service (AKS) cluster. Then you use Azure Managed Grafana's managed private endpoint to connect to this Prometheus server and display the Prometheus data in a Grafana dashboard

ARM template resource definition

The grafana/managedPrivateEndpoints resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Dashboard/grafana/managedPrivateEndpoints resource, add the following JSON to your template.

{
  "type": "Microsoft.Dashboard/grafana/managedPrivateEndpoints",
  "apiVersion": "2024-11-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "groupIds": [ "string" ],
    "privateLinkResourceId": "string",
    "privateLinkResourceRegion": "string",
    "privateLinkServiceUrl": "string",
    "requestMessage": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Dashboard/grafana/managedPrivateEndpoints

Name Description Value
apiVersion The api version '2024-11-01-preview'
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties Resource properties. ManagedPrivateEndpointModelProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Dashboard/grafana/managedPrivateEndpoints'

ManagedPrivateEndpointModelProperties

Name Description Value
groupIds The group Ids of the managed private endpoint. string[]
privateLinkResourceId The ARM resource ID of the resource for which the managed private endpoint is pointing to. string
privateLinkResourceRegion The region of the resource to which the managed private endpoint is pointing to. string
privateLinkServiceUrl The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port. string
requestMessage User input request message of the managed private endpoint. string

TrackedResourceTags

Name Description Value

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Create AKS with Prometheus and Grafana with privae link

Deploy to Azure
This will create an Azure grafana, AKS and install Prometheus, an open-source monitoring and alerting toolkit, on an Azure Kubernetes Service (AKS) cluster. Then you use Azure Managed Grafana's managed private endpoint to connect to this Prometheus server and display the Prometheus data in a Grafana dashboard

Terraform (AzAPI provider) resource definition

The grafana/managedPrivateEndpoints resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Dashboard/grafana/managedPrivateEndpoints resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Dashboard/grafana/managedPrivateEndpoints@2024-11-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      groupIds = [
        "string"
      ]
      privateLinkResourceId = "string"
      privateLinkResourceRegion = "string"
      privateLinkServiceUrl = "string"
      requestMessage = "string"
    }
  }
}

Property Values

Microsoft.Dashboard/grafana/managedPrivateEndpoints

Name Description Value
location The geo-location where the resource lives string (required)
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: grafana
properties Resource properties. ManagedPrivateEndpointModelProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Dashboard/grafana/managedPrivateEndpoints@2024-11-01-preview"

ManagedPrivateEndpointModelProperties

Name Description Value
groupIds The group Ids of the managed private endpoint. string[]
privateLinkResourceId The ARM resource ID of the resource for which the managed private endpoint is pointing to. string
privateLinkResourceRegion The region of the resource to which the managed private endpoint is pointing to. string
privateLinkServiceUrl The URL of the data store behind the private link service. It would be the URL in the Grafana data source configuration page without the protocol and port. string
requestMessage User input request message of the managed private endpoint. string

TrackedResourceTags

Name Description Value