Grafana v0.7.0 published on Tuesday, Nov 5, 2024 by pulumiverse
grafana.syntheticMonitoring.getProbe
Explore with Pulumi AI
Data source for retrieving a single probe by name.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as grafana from "@pulumi/grafana";
const atlanta = grafana.syntheticMonitoring.getProbe({
    name: "Atlanta",
});
import pulumi
import pulumi_grafana as grafana
atlanta = grafana.syntheticMonitoring.get_probe(name="Atlanta")
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.GetProbe(ctx, &syntheticmonitoring.GetProbeArgs{
			Name: "Atlanta",
		}, 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 atlanta = Grafana.SyntheticMonitoring.GetProbe.Invoke(new()
    {
        Name = "Atlanta",
    });
});
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 atlanta = SyntheticMonitoringFunctions.getProbe(GetProbeArgs.builder()
            .name("Atlanta")
            .build());
    }
}
variables:
  atlanta:
    fn::invoke:
      Function: grafana:syntheticMonitoring:getProbe
      Arguments:
        name: Atlanta
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 GetProbe(ctx *Context, args *GetProbeArgs, opts ...InvokeOption) (*GetProbeResult, error)
func GetProbeOutput(ctx *Context, args *GetProbeOutputArgs, opts ...InvokeOption) GetProbeResultOutput> Note: This function is named GetProbe 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)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: grafana:syntheticMonitoring/getProbe:getProbe
  arguments:
    # arguments dictionaryThe 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:
- Disable
Scripted boolChecks  - 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.
 - Tenant
Id int - The tenant ID of the probe.
 
- Disable
Scripted boolChecks  - 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.
 - Tenant
Id int - The tenant ID of the probe.
 
- disable
Scripted BooleanChecks  - 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.
 - tenant
Id Integer - The tenant ID of the probe.
 
- disable
Scripted booleanChecks  - 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.
 - tenant
Id number - The tenant ID of the probe.
 
- disable_
scripted_ boolchecks  - 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.
 
- disable
Scripted BooleanChecks  - 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.
 - tenant
Id 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 
grafanaTerraform Provider.