Oracle Cloud Infrastructure v2.11.0, Sep 19 24

Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

oci.HealthChecks.getPingMonitors

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testPingMonitors = oci.HealthChecks.getPingMonitors({
    compartmentId: compartmentId,
    displayName: pingMonitorDisplayName,
    homeRegion: pingMonitorHomeRegion,
});

import pulumi
import pulumi_oci as oci

test_ping_monitors = oci.HealthChecks.get_ping_monitors(compartment_id=compartment_id,
    display_name=ping_monitor_display_name,
    home_region=ping_monitor_home_region)

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/HealthChecks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := HealthChecks.GetPingMonitors(ctx, &healthchecks.GetPingMonitorsArgs{
			CompartmentId: compartmentId,
			DisplayName:   pulumi.StringRef(pingMonitorDisplayName),
			HomeRegion:    pulumi.StringRef(pingMonitorHomeRegion),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var testPingMonitors = Oci.HealthChecks.GetPingMonitors.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = pingMonitorDisplayName,
        HomeRegion = pingMonitorHomeRegion,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.HealthChecks.HealthChecksFunctions;
import com.pulumi.oci.HealthChecks.inputs.GetPingMonitorsArgs;
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 testPingMonitors = HealthChecksFunctions.getPingMonitors(GetPingMonitorsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(pingMonitorDisplayName)
            .homeRegion(pingMonitorHomeRegion)
            .build());

    }
}

variables:
  testPingMonitors:
    fn::invoke:
      Function: oci:HealthChecks:getPingMonitors
      Arguments:
        compartmentId: ${compartmentId}
        displayName: ${pingMonitorDisplayName}
        homeRegion: ${pingMonitorHomeRegion}

Using getPingMonitors

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 getPingMonitors(args: GetPingMonitorsArgs, opts?: InvokeOptions): Promise<GetPingMonitorsResult>
function getPingMonitorsOutput(args: GetPingMonitorsOutputArgs, opts?: InvokeOptions): Output<GetPingMonitorsResult>

def get_ping_monitors(compartment_id: Optional[str] = None,
                      display_name: Optional[str] = None,
                      filters: Optional[Sequence[_healthchecks.GetPingMonitorsFilter]] = None,
                      home_region: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetPingMonitorsResult
def get_ping_monitors_output(compartment_id: Optional[pulumi.Input[str]] = None,
                      display_name: Optional[pulumi.Input[str]] = None,
                      filters: Optional[pulumi.Input[Sequence[pulumi.Input[_healthchecks.GetPingMonitorsFilterArgs]]]] = None,
                      home_region: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetPingMonitorsResult]

func GetPingMonitors(ctx *Context, args *GetPingMonitorsArgs, opts ...InvokeOption) (*GetPingMonitorsResult, error)
func GetPingMonitorsOutput(ctx *Context, args *GetPingMonitorsOutputArgs, opts ...InvokeOption) GetPingMonitorsResultOutput

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

public static class GetPingMonitors 
{
    public static Task<GetPingMonitorsResult> InvokeAsync(GetPingMonitorsArgs args, InvokeOptions? opts = null)
    public static Output<GetPingMonitorsResult> Invoke(GetPingMonitorsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetPingMonitorsResult> getPingMonitors(GetPingMonitorsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:HealthChecks/getPingMonitors:getPingMonitors
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: Filters results by compartment.
DisplayName string: Filters results that exactly match the displayName field.
Filters List<GetPingMonitorsFilter>
HomeRegion string: Filters results that match the homeRegion.

CompartmentId string: Filters results by compartment.
DisplayName string: Filters results that exactly match the displayName field.
Filters []GetPingMonitorsFilter
HomeRegion string: Filters results that match the homeRegion.

compartmentId String: Filters results by compartment.
displayName String: Filters results that exactly match the displayName field.
filters List<GetPingMonitorsFilter>
homeRegion String: Filters results that match the homeRegion.

compartmentId string: Filters results by compartment.
displayName string: Filters results that exactly match the displayName field.
filters GetPingMonitorsFilter[]
homeRegion string: Filters results that match the homeRegion.

compartment_id str: Filters results by compartment.
display_name str: Filters results that exactly match the displayName field.
filters Sequence[healthchecks.GetPingMonitorsFilter]
home_region str: Filters results that match the homeRegion.

compartmentId String: Filters results by compartment.
displayName String: Filters results that exactly match the displayName field.
filters List<Property Map>
homeRegion String: Filters results that match the homeRegion.

getPingMonitors Result

The following output properties are available:

CompartmentId string: The OCID of the compartment.
Id string: The provider-assigned unique ID for this managed resource.
PingMonitors List<GetPingMonitorsPingMonitor>: The list of ping_monitors.
DisplayName string: A user-friendly and mutable name suitable for display in a user interface.
Filters List<GetPingMonitorsFilter>
HomeRegion string: The region where updates must be made and where results must be fetched from.

CompartmentId string: The OCID of the compartment.
Id string: The provider-assigned unique ID for this managed resource.
PingMonitors []GetPingMonitorsPingMonitor: The list of ping_monitors.
DisplayName string: A user-friendly and mutable name suitable for display in a user interface.
Filters []GetPingMonitorsFilter
HomeRegion string: The region where updates must be made and where results must be fetched from.

compartmentId String: The OCID of the compartment.
id String: The provider-assigned unique ID for this managed resource.
pingMonitors List<GetPingMonitorsPingMonitor>: The list of ping_monitors.
displayName String: A user-friendly and mutable name suitable for display in a user interface.
filters List<GetPingMonitorsFilter>
homeRegion String: The region where updates must be made and where results must be fetched from.

compartmentId string: The OCID of the compartment.
id string: The provider-assigned unique ID for this managed resource.
pingMonitors GetPingMonitorsPingMonitor[]: The list of ping_monitors.
displayName string: A user-friendly and mutable name suitable for display in a user interface.
filters GetPingMonitorsFilter[]
homeRegion string: The region where updates must be made and where results must be fetched from.

compartment_id str: The OCID of the compartment.
id str: The provider-assigned unique ID for this managed resource.
ping_monitors Sequence[healthchecks.GetPingMonitorsPingMonitor]: The list of ping_monitors.
display_name str: A user-friendly and mutable name suitable for display in a user interface.
filters Sequence[healthchecks.GetPingMonitorsFilter]
home_region str: The region where updates must be made and where results must be fetched from.

compartmentId String: The OCID of the compartment.
id String: The provider-assigned unique ID for this managed resource.
pingMonitors List<Property Map>: The list of ping_monitors.
displayName String: A user-friendly and mutable name suitable for display in a user interface.
filters List<Property Map>
homeRegion String: The region where updates must be made and where results must be fetched from.

Supporting Types

GetPingMonitorsFilter

Name string
Values List<string>
Regex bool

Name string
Values []string
Regex bool

name String
values List<String>
regex Boolean

name string
values string[]
regex boolean

name str
values Sequence[str]
regex bool

name String
values List<String>
regex Boolean

GetPingMonitorsPingMonitor

CompartmentId string: Filters results by compartment.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string: Filters results that exactly match the displayName field.
FreeformTags Dictionary<string, string>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
HomeRegion string: Filters results that match the homeRegion.
Id string: The OCID of the resource.
IntervalInSeconds int: The monitor interval in seconds. Valid values: 10, 30, and 60.
IsEnabled bool: Enables or disables the monitor. Set to 'true' to launch monitoring.
Port int: The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
Protocol string: The protocols for ping probes.
ResultsUrl string: A URL for fetching the probe results.
Targets List<string>: A list of targets (hostnames or IP addresses) of the probe.
TimeCreated string: The RFC 3339-formatted creation date and time of the probe.
TimeoutInSeconds int: The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.
VantagePointNames List<string>: A list of names of vantage points from which to execute the probe.

CompartmentId string: Filters results by compartment.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
DisplayName string: Filters results that exactly match the displayName field.
FreeformTags map[string]string: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
HomeRegion string: Filters results that match the homeRegion.
Id string: The OCID of the resource.
IntervalInSeconds int: The monitor interval in seconds. Valid values: 10, 30, and 60.
IsEnabled bool: Enables or disables the monitor. Set to 'true' to launch monitoring.
Port int: The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
Protocol string: The protocols for ping probes.
ResultsUrl string: A URL for fetching the probe results.
Targets []string: A list of targets (hostnames or IP addresses) of the probe.
TimeCreated string: The RFC 3339-formatted creation date and time of the probe.
TimeoutInSeconds int: The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.
VantagePointNames []string: A list of names of vantage points from which to execute the probe.

compartmentId String: Filters results by compartment.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String: Filters results that exactly match the displayName field.
freeformTags Map<String,String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
homeRegion String: Filters results that match the homeRegion.
id String: The OCID of the resource.
intervalInSeconds Integer: The monitor interval in seconds. Valid values: 10, 30, and 60.
isEnabled Boolean: Enables or disables the monitor. Set to 'true' to launch monitoring.
port Integer: The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
protocol String: The protocols for ping probes.
resultsUrl String: A URL for fetching the probe results.
targets List<String>: A list of targets (hostnames or IP addresses) of the probe.
timeCreated String: The RFC 3339-formatted creation date and time of the probe.
timeoutInSeconds Integer: The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.
vantagePointNames List<String>: A list of names of vantage points from which to execute the probe.

compartmentId string: Filters results by compartment.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName string: Filters results that exactly match the displayName field.
freeformTags {[key: string]: string}: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
homeRegion string: Filters results that match the homeRegion.
id string: The OCID of the resource.
intervalInSeconds number: The monitor interval in seconds. Valid values: 10, 30, and 60.
isEnabled boolean: Enables or disables the monitor. Set to 'true' to launch monitoring.
port number: The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
protocol string: The protocols for ping probes.
resultsUrl string: A URL for fetching the probe results.
targets string[]: A list of targets (hostnames or IP addresses) of the probe.
timeCreated string: The RFC 3339-formatted creation date and time of the probe.
timeoutInSeconds number: The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.
vantagePointNames string[]: A list of names of vantage points from which to execute the probe.

compartment_id str: Filters results by compartment.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
display_name str: Filters results that exactly match the displayName field.
freeform_tags Mapping[str, str]: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
home_region str: Filters results that match the homeRegion.
id str: The OCID of the resource.
interval_in_seconds int: The monitor interval in seconds. Valid values: 10, 30, and 60.
is_enabled bool: Enables or disables the monitor. Set to 'true' to launch monitoring.
port int: The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
protocol str: The protocols for ping probes.
results_url str: A URL for fetching the probe results.
targets Sequence[str]: A list of targets (hostnames or IP addresses) of the probe.
time_created str: The RFC 3339-formatted creation date and time of the probe.
timeout_in_seconds int: The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.
vantage_point_names Sequence[str]: A list of names of vantage points from which to execute the probe.

compartmentId String: Filters results by compartment.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
displayName String: Filters results that exactly match the displayName field.
freeformTags Map<String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
homeRegion String: Filters results that match the homeRegion.
id String: The OCID of the resource.
intervalInSeconds Number: The monitor interval in seconds. Valid values: 10, 30, and 60.
isEnabled Boolean: Enables or disables the monitor. Set to 'true' to launch monitoring.
port Number: The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
protocol String: The protocols for ping probes.
resultsUrl String: A URL for fetching the probe results.
targets List<String>: A list of targets (hostnames or IP addresses) of the probe.
timeCreated String: The RFC 3339-formatted creation date and time of the probe.
timeoutInSeconds Number: The probe timeout in seconds. Valid values: 10, 20, 30, and 60. The probe timeout must be less than or equal to intervalInSeconds for monitors.
vantagePointNames List<String>: A list of names of vantage points from which to execute the probe.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Oracle Cloud Infrastructure v2.11.0 published on Thursday, Sep 19, 2024 by Pulumi

pulumi/pulumi-oci

oci.HealthChecks.getPingMonitors

On this page

On this page

Example Usage

Using getPingMonitors

getPingMonitors Result

Supporting Types

GetPingMonitorsFilter

GetPingMonitorsPingMonitor

Package Details

On this page

On this page