1. Packages
  2. Grafana Cloud
  3. API Docs
  4. syntheticMonitoring
  5. getProbe
Viewing docs for Grafana v2.21.0
published on Tuesday, Mar 3, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-grafana

grafana.syntheticMonitoring.getProbe

grafana logo
Viewing docs for Grafana v2.21.0
published on Tuesday, Mar 3, 2026 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-grafana

    Data source for retrieving a single probe by name.

    Example Usage

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

const ohio = grafana.syntheticMonitoring.getProbe({
    name: "Ohio",
});

    import pulumi
import pulumi_grafana as grafana

ohio = grafana.syntheticMonitoring.get_probe(name="Ohio")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := syntheticmonitoring.GetProbe(ctx, &syntheticmonitoring.GetProbeArgs{
			Name: "Ohio",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Grafana = Pulumi.Grafana;

return await Deployment.RunAsync(() => 
{
    var ohio = Grafana.SyntheticMonitoring.GetProbe.Invoke(new()
    {
        Name = "Ohio",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.grafana.syntheticMonitoring.SyntheticMonitoringFunctions;
import com.pulumi.grafana.syntheticMonitoring.inputs.GetProbeArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

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

    public static void stack(Context ctx) {
        final var ohio = SyntheticMonitoringFunctions.getProbe(GetProbeArgs.builder()
            .name("Ohio")
            .build());

    }
}

    variables:
  ohio:
    fn::invoke:
      function: grafana:syntheticMonitoring:getProbe
      arguments:
        name: Ohio

    Using getProbe

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

    function getProbe(args: GetProbeArgs, opts?: InvokeOptions): Promise<GetProbeResult>
function getProbeOutput(args: GetProbeOutputArgs, opts?: InvokeOptions): Output<GetProbeResult>
    def get_probe(name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetProbeResult
def get_probe_output(name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetProbeResult]
    func LookupProbe(ctx *Context, args *LookupProbeArgs, opts ...InvokeOption) (*LookupProbeResult, error)
func LookupProbeOutput(ctx *Context, args *LookupProbeOutputArgs, opts ...InvokeOption) LookupProbeResultOutput

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

    public static class GetProbe 
{
    public static Task<GetProbeResult> InvokeAsync(GetProbeArgs args, InvokeOptions? opts = null)
    public static Output<GetProbeResult> Invoke(GetProbeInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetProbeResult> getProbe(GetProbeArgs args, InvokeOptions options)
public static Output<GetProbeResult> getProbe(GetProbeArgs args, InvokeOptions options)

    fn::invoke:
  function: grafana:syntheticMonitoring/getProbe:getProbe
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Name string
    Name of the probe.
    Name string
    Name of the probe.
    name String
    Name of the probe.
    name string
    Name of the probe.
    name str
    Name of the probe.
    name String
    Name of the probe.

    getProbe Result

    The following output properties are available:

    DisableBrowserChecks bool
    Disables browser checks for this probe.
    DisableScriptedChecks bool
    Disables scripted checks for this probe.
    Id string
    The ID of the probe.
    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.
    Region string
    Region of the probe.
    TenantId int
    The tenant ID of the probe.
    DisableBrowserChecks bool
    Disables browser checks for this probe.
    DisableScriptedChecks bool
    Disables scripted checks for this probe.
    Id string
    The ID of the probe.
    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.
    Region string
    Region of the probe.
    TenantId int
    The tenant ID of the probe.
    disableBrowserChecks Boolean
    Disables browser checks for this probe.
    disableScriptedChecks Boolean
    Disables scripted checks for this probe.
    id String
    The ID of the probe.
    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.
    region String
    Region of the probe.
    tenantId Integer
    The tenant ID of the probe.
    disableBrowserChecks boolean
    Disables browser checks for this probe.
    disableScriptedChecks boolean
    Disables scripted checks for this probe.
    id string
    The ID of the probe.
    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.
    region string
    Region of the probe.
    tenantId number
    The tenant ID of the probe.
    disable_browser_checks bool
    Disables browser checks for this probe.
    disable_scripted_checks bool
    Disables scripted checks for this probe.
    id str
    The ID of the probe.
    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.
    region str
    Region of the probe.
    tenant_id int
    The tenant ID of the probe.
    disableBrowserChecks Boolean
    Disables browser checks for this probe.
    disableScriptedChecks Boolean
    Disables scripted checks for this probe.
    id String
    The ID of the probe.
    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.
    region String
    Region of the probe.
    tenantId Number
    The tenant ID of the probe.

    Package Details

    Repository
    grafana pulumiverse/pulumi-grafana
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the grafana Terraform Provider.
    grafana logo
    Viewing docs for Grafana v2.21.0
    published on Tuesday, Mar 3, 2026 by pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-grafana
      Try Pulumi Cloud free. Your team will thank you.