Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Grafana Cloud
  3. API Docs
  4. syntheticMonitoring
  5. Probe
Grafana v0.16.3 published on Monday, Apr 7, 2025 by pulumiverse
pulumiverse/pulumi-grafana

grafana.syntheticMonitoring.Probe

Explore with Pulumi AI

Grafana v0.16.3 published on Monday, Apr 7, 2025 by pulumiverse
pulumiverse/pulumi-grafana

Besides the public probes run by Grafana Labs, you can also install your own private probes. These are only accessible to you and only write data to your Grafana Cloud account. Private probes are instances of the open source Grafana Synthetic Monitoring Agent.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as grafana from "@pulumiverse/grafana";

const main = new grafana.syntheticmonitoring.Probe("main", {
    name: "Mount Everest",
    latitude: 27.98606,
    longitude: 86.92262,
    region: "APAC",
    labels: {
        type: "mountain",
    },
});
Copy
import pulumi
import pulumiverse_grafana as grafana

main = grafana.synthetic_monitoring.Probe("main",
    name="Mount Everest",
    latitude=27.98606,
    longitude=86.92262,
    region="APAC",
    labels={
        "type": "mountain",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-grafana/sdk/go/grafana/syntheticmonitoring"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := syntheticmonitoring.NewProbe(ctx, "main", &syntheticmonitoring.ProbeArgs{
			Name:      pulumi.String("Mount Everest"),
			Latitude:  pulumi.Float64(27.98606),
			Longitude: pulumi.Float64(86.92262),
			Region:    pulumi.String("APAC"),
			Labels: pulumi.StringMap{
				"type": pulumi.String("mountain"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Grafana = Pulumiverse.Grafana;

return await Deployment.RunAsync(() => 
{
    var main = new Grafana.SyntheticMonitoring.Probe("main", new()
    {
        Name = "Mount Everest",
        Latitude = 27.98606,
        Longitude = 86.92262,
        Region = "APAC",
        Labels = 
        {
            { "type", "mountain" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.grafana.syntheticMonitoring.Probe;
import com.pulumi.grafana.syntheticMonitoring.ProbeArgs;
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 main = new Probe("main", ProbeArgs.builder()
            .name("Mount Everest")
            .latitude(27.98606)
            .longitude(86.92262)
            .region("APAC")
            .labels(Map.of("type", "mountain"))
            .build());

    }
}
Copy
resources:
  main:
    type: grafana:syntheticMonitoring:Probe
    properties:
      name: Mount Everest
      latitude: 27.98606
      longitude: 86.92262
      region: APAC
      labels:
        type: mountain
Copy

Create Probe Resource

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

Constructor syntax

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

@overload
def Probe(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          latitude: Optional[float] = None,
          longitude: Optional[float] = None,
          region: Optional[str] = None,
          disable_browser_checks: Optional[bool] = None,
          disable_scripted_checks: Optional[bool] = None,
          labels: Optional[Mapping[str, str]] = None,
          name: Optional[str] = None,
          public: Optional[bool] = None)
func NewProbe(ctx *Context, name string, args ProbeArgs, opts ...ResourceOption) (*Probe, error)
public Probe(string name, ProbeArgs args, CustomResourceOptions? opts = null)
public Probe(String name, ProbeArgs args)
public Probe(String name, ProbeArgs args, CustomResourceOptions options)

type: grafana:syntheticMonitoring:Probe
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. ProbeArgs
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. ProbeArgs
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. ProbeArgs
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. ProbeArgs
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. ProbeArgs
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 probeResource = new Grafana.SyntheticMonitoring.Probe("probeResource", new()
{
    Latitude = 0,
    Longitude = 0,
    Region = "string",
    DisableBrowserChecks = false,
    DisableScriptedChecks = false,
    Labels = 
    {
        { "string", "string" },
    },
    Name = "string",
    Public = false,
});
Copy
example, err := syntheticMonitoring.NewProbe(ctx, "probeResource", &syntheticMonitoring.ProbeArgs{
	Latitude:              pulumi.Float64(0),
	Longitude:             pulumi.Float64(0),
	Region:                pulumi.String("string"),
	DisableBrowserChecks:  pulumi.Bool(false),
	DisableScriptedChecks: pulumi.Bool(false),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:   pulumi.String("string"),
	Public: pulumi.Bool(false),
})
Copy
var probeResource = new Probe("probeResource", ProbeArgs.builder()
    .latitude(0)
    .longitude(0)
    .region("string")
    .disableBrowserChecks(false)
    .disableScriptedChecks(false)
    .labels(Map.of("string", "string"))
    .name("string")
    .public_(false)
    .build());
Copy
probe_resource = grafana.synthetic_monitoring.Probe("probeResource",
    latitude=0,
    longitude=0,
    region="string",
    disable_browser_checks=False,
    disable_scripted_checks=False,
    labels={
        "string": "string",
    },
    name="string",
    public=False)
Copy
const probeResource = new grafana.syntheticmonitoring.Probe("probeResource", {
    latitude: 0,
    longitude: 0,
    region: "string",
    disableBrowserChecks: false,
    disableScriptedChecks: false,
    labels: {
        string: "string",
    },
    name: "string",
    "public": false,
});
Copy
type: grafana:syntheticMonitoring:Probe
properties:
    disableBrowserChecks: false
    disableScriptedChecks: false
    labels:
        string: string
    latitude: 0
    longitude: 0
    name: string
    public: false
    region: string
Copy

Probe 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 Probe resource accepts the following input properties:

Latitude This property is required. double
Latitude coordinates.
Longitude This property is required. double
Longitude coordinates.
Region This property is required. string
Region of the probe.
DisableBrowserChecks bool
Disables browser checks for this probe. Defaults to false.
DisableScriptedChecks bool
Disables scripted checks for this probe. Defaults to false.
Labels Dictionary<string, string>
Custom labels to be included with collected metrics and logs.
Name string
Name of the probe.
Public bool
Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.
Latitude This property is required. float64
Latitude coordinates.
Longitude This property is required. float64
Longitude coordinates.
Region This property is required. string
Region of the probe.
DisableBrowserChecks bool
Disables browser checks for this probe. Defaults to false.
DisableScriptedChecks bool
Disables scripted checks for this probe. Defaults to false.
Labels map[string]string
Custom labels to be included with collected metrics and logs.
Name string
Name of the probe.
Public bool
Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.
latitude This property is required. Double
Latitude coordinates.
longitude This property is required. Double
Longitude coordinates.
region This property is required. String
Region of the probe.
disableBrowserChecks Boolean
Disables browser checks for this probe. Defaults to false.
disableScriptedChecks Boolean
Disables scripted checks for this probe. Defaults to false.
labels Map<String,String>
Custom labels to be included with collected metrics and logs.
name String
Name of the probe.
public_ Boolean
Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.
latitude This property is required. number
Latitude coordinates.
longitude This property is required. number
Longitude coordinates.
region This property is required. string
Region of the probe.
disableBrowserChecks boolean
Disables browser checks for this probe. Defaults to false.
disableScriptedChecks boolean
Disables scripted checks for this probe. Defaults to false.
labels {[key: string]: string}
Custom labels to be included with collected metrics and logs.
name string
Name of the probe.
public boolean
Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.
latitude This property is required. float
Latitude coordinates.
longitude This property is required. float
Longitude coordinates.
region This property is required. str
Region of the probe.
disable_browser_checks bool
Disables browser checks for this probe. Defaults to false.
disable_scripted_checks bool
Disables scripted checks for this probe. Defaults to false.
labels Mapping[str, str]
Custom labels to be included with collected metrics and logs.
name str
Name of the probe.
public bool
Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.
latitude This property is required. Number
Latitude coordinates.
longitude This property is required. Number
Longitude coordinates.
region This property is required. String
Region of the probe.
disableBrowserChecks Boolean
Disables browser checks for this probe. Defaults to false.
disableScriptedChecks Boolean
Disables scripted checks for this probe. Defaults to false.
labels Map<String>
Custom labels to be included with collected metrics and logs.
name String
Name of the probe.
public Boolean
Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.

Outputs

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

AuthToken string
The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.
Id string
The provider-assigned unique ID for this managed resource.
TenantId int
The tenant ID of the probe.
AuthToken string
The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.
Id string
The provider-assigned unique ID for this managed resource.
TenantId int
The tenant ID of the probe.
authToken String
The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.
id String
The provider-assigned unique ID for this managed resource.
tenantId Integer
The tenant ID of the probe.
authToken string
The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.
id string
The provider-assigned unique ID for this managed resource.
tenantId number
The tenant ID of the probe.
auth_token str
The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.
id str
The provider-assigned unique ID for this managed resource.
tenant_id int
The tenant ID of the probe.
authToken String
The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.
id String
The provider-assigned unique ID for this managed resource.
tenantId Number
The tenant ID of the probe.

Look up Existing Probe Resource

Get an existing Probe 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?: ProbeState, opts?: CustomResourceOptions): Probe
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth_token: Optional[str] = None,
        disable_browser_checks: Optional[bool] = None,
        disable_scripted_checks: Optional[bool] = None,
        labels: Optional[Mapping[str, str]] = None,
        latitude: Optional[float] = None,
        longitude: Optional[float] = None,
        name: Optional[str] = None,
        public: Optional[bool] = None,
        region: Optional[str] = None,
        tenant_id: Optional[int] = None) -> Probe
func GetProbe(ctx *Context, name string, id IDInput, state *ProbeState, opts ...ResourceOption) (*Probe, error)
public static Probe Get(string name, Input<string> id, ProbeState? state, CustomResourceOptions? opts = null)
public static Probe get(String name, Output<String> id, ProbeState state, CustomResourceOptions options)
resources:  _:    type: grafana:syntheticMonitoring:Probe    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:
AuthToken string
The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.
DisableBrowserChecks bool
Disables browser checks for this probe. Defaults to false.
DisableScriptedChecks bool
Disables scripted checks for this probe. Defaults to false.
Labels Dictionary<string, string>
Custom labels to be included with collected metrics and logs.
Latitude double
Latitude coordinates.
Longitude double
Longitude coordinates.
Name string
Name of the probe.
Public bool
Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.
Region string
Region of the probe.
TenantId int
The tenant ID of the probe.
AuthToken string
The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.
DisableBrowserChecks bool
Disables browser checks for this probe. Defaults to false.
DisableScriptedChecks bool
Disables scripted checks for this probe. Defaults to false.
Labels map[string]string
Custom labels to be included with collected metrics and logs.
Latitude float64
Latitude coordinates.
Longitude float64
Longitude coordinates.
Name string
Name of the probe.
Public bool
Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.
Region string
Region of the probe.
TenantId int
The tenant ID of the probe.
authToken String
The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.
disableBrowserChecks Boolean
Disables browser checks for this probe. Defaults to false.
disableScriptedChecks Boolean
Disables scripted checks for this probe. Defaults to false.
labels Map<String,String>
Custom labels to be included with collected metrics and logs.
latitude Double
Latitude coordinates.
longitude Double
Longitude coordinates.
name String
Name of the probe.
public_ Boolean
Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.
region String
Region of the probe.
tenantId Integer
The tenant ID of the probe.
authToken string
The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.
disableBrowserChecks boolean
Disables browser checks for this probe. Defaults to false.
disableScriptedChecks boolean
Disables scripted checks for this probe. Defaults to false.
labels {[key: string]: string}
Custom labels to be included with collected metrics and logs.
latitude number
Latitude coordinates.
longitude number
Longitude coordinates.
name string
Name of the probe.
public boolean
Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.
region string
Region of the probe.
tenantId number
The tenant ID of the probe.
auth_token str
The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.
disable_browser_checks bool
Disables browser checks for this probe. Defaults to false.
disable_scripted_checks bool
Disables scripted checks for this probe. Defaults to false.
labels Mapping[str, str]
Custom labels to be included with collected metrics and logs.
latitude float
Latitude coordinates.
longitude float
Longitude coordinates.
name str
Name of the probe.
public bool
Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.
region str
Region of the probe.
tenant_id int
The tenant ID of the probe.
authToken String
The probe authentication token. Your probe must use this to authenticate with Grafana Cloud.
disableBrowserChecks Boolean
Disables browser checks for this probe. Defaults to false.
disableScriptedChecks Boolean
Disables scripted checks for this probe. Defaults to false.
labels Map<String>
Custom labels to be included with collected metrics and logs.
latitude Number
Latitude coordinates.
longitude Number
Longitude coordinates.
name String
Name of the probe.
public Boolean
Public probes are run by Grafana Labs and can be used by all users. Only Grafana Labs managed public probes will be set to true. Defaults to false.
region String
Region of the probe.
tenantId Number
The tenant ID of the probe.

Import

$ pulumi import grafana:syntheticMonitoring/probe:Probe name "{{ id }}"
Copy
$ pulumi import grafana:syntheticMonitoring/probe:Probe name "{{ id }}:{{ authToken }}"
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
grafana pulumiverse/pulumi-grafana
License
Apache-2.0
Notes
This Pulumi package is based on the grafana Terraform Provider.
Grafana v0.16.3 published on Monday, Apr 7, 2025 by pulumiverse
pulumiverse/pulumi-grafana