Oracle Cloud Infrastructure v0.12.0, Mar 17 23

oci.HealthChecks.getHttpMonitors

This data source provides the list of Http Monitors in Oracle Cloud Infrastructure Health Checks service.

Gets a list of HTTP monitors.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testHttpMonitors = Oci.HealthChecks.GetHttpMonitors.Invoke(new()
    {
        CompartmentId = @var.Compartment_id,
        DisplayName = @var.Http_monitor_display_name,
        HomeRegion = @var.Http_monitor_home_region,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := HealthChecks.GetHttpMonitors(ctx, &healthchecks.GetHttpMonitorsArgs{
			CompartmentId: _var.Compartment_id,
			DisplayName:   pulumi.StringRef(_var.Http_monitor_display_name),
			HomeRegion:    pulumi.StringRef(_var.Http_monitor_home_region),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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.GetHttpMonitorsArgs;
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 testHttpMonitors = HealthChecksFunctions.getHttpMonitors(GetHttpMonitorsArgs.builder()
            .compartmentId(var_.compartment_id())
            .displayName(var_.http_monitor_display_name())
            .homeRegion(var_.http_monitor_home_region())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_http_monitors = oci.HealthChecks.get_http_monitors(compartment_id=var["compartment_id"],
    display_name=var["http_monitor_display_name"],
    home_region=var["http_monitor_home_region"])

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

const testHttpMonitors = oci.HealthChecks.getHttpMonitors({
    compartmentId: _var.compartment_id,
    displayName: _var.http_monitor_display_name,
    homeRegion: _var.http_monitor_home_region,
});

variables:
  testHttpMonitors:
    fn::invoke:
      Function: oci:HealthChecks:getHttpMonitors
      Arguments:
        compartmentId: ${var.compartment_id}
        displayName: ${var.http_monitor_display_name}
        homeRegion: ${var.http_monitor_home_region}

Using getHttpMonitors

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 getHttpMonitors(args: GetHttpMonitorsArgs, opts?: InvokeOptions): Promise<GetHttpMonitorsResult>
function getHttpMonitorsOutput(args: GetHttpMonitorsOutputArgs, opts?: InvokeOptions): Output<GetHttpMonitorsResult>

def get_http_monitors(compartment_id: Optional[str] = None,
                      display_name: Optional[str] = None,
                      filters: Optional[Sequence[_healthchecks.GetHttpMonitorsFilter]] = None,
                      home_region: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetHttpMonitorsResult
def get_http_monitors_output(compartment_id: Optional[pulumi.Input[str]] = None,
                      display_name: Optional[pulumi.Input[str]] = None,
                      filters: Optional[pulumi.Input[Sequence[pulumi.Input[_healthchecks.GetHttpMonitorsFilterArgs]]]] = None,
                      home_region: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetHttpMonitorsResult]

func GetHttpMonitors(ctx *Context, args *GetHttpMonitorsArgs, opts ...InvokeOption) (*GetHttpMonitorsResult, error)
func GetHttpMonitorsOutput(ctx *Context, args *GetHttpMonitorsOutputArgs, opts ...InvokeOption) GetHttpMonitorsResultOutput

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

public static class GetHttpMonitors 
{
    public static Task<GetHttpMonitorsResult> InvokeAsync(GetHttpMonitorsArgs args, InvokeOptions? opts = null)
    public static Output<GetHttpMonitorsResult> Invoke(GetHttpMonitorsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetHttpMonitorsResult> getHttpMonitors(GetHttpMonitorsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:HealthChecks/getHttpMonitors:getHttpMonitors
  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<GetHttpMonitorsFilter>
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 []GetHttpMonitorsFilter
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<GetHttpMonitorsFilter>
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 GetHttpMonitorsFilter[]
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 GetHttpMonitorsFilter]
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.

getHttpMonitors Result

The following output properties are available:

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

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

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

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

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

compartmentId String: The OCID of the compartment.
httpMonitors List<Property Map>: The list of http_monitors.
id String: The provider-assigned unique ID for this managed resource.
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

GetHttpMonitorsFilter

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

GetHttpMonitorsHttpMonitor

CompartmentId string: Filters results by compartment.
DefinedTags Dictionary<string, object>: 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, object>: 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"}
Headers Dictionary<string, object>: A dictionary of HTTP request headers.
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.
Method string: The supported HTTP methods available for probes.
Path string: The optional URL path to probe, including query parameters.
Port int: The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
Protocol string: The supported protocols available for HTTP 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]interface{}: 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]interface{}: 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"}
Headers map[string]interface{}: A dictionary of HTTP request headers.
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.
Method string: The supported HTTP methods available for probes.
Path string: The optional URL path to probe, including query parameters.
Port int: The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
Protocol string: The supported protocols available for HTTP 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,Object>: 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,Object>: 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"}
headers Map<String,Object>: A dictionary of HTTP request headers.
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.
method String: The supported HTTP methods available for probes.
path String: The optional URL path to probe, including query parameters.
port Integer: The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
protocol String: The supported protocols available for HTTP 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]: any}: 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]: any}: 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"}
headers {[key: string]: any}: A dictionary of HTTP request headers.
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.
method string: The supported HTTP methods available for probes.
path string: The optional URL path to probe, including query parameters.
port number: The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
protocol string: The supported protocols available for HTTP 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, Any]: 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, Any]: 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"}
headers Mapping[str, Any]: A dictionary of HTTP request headers.
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.
method str: The supported HTTP methods available for probes.
path str: The optional URL path to probe, including query parameters.
port int: The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
protocol str: The supported protocols available for HTTP 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<Any>: 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<Any>: 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"}
headers Map<Any>: A dictionary of HTTP request headers.
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.
method String: The supported HTTP methods available for probes.
path String: The optional URL path to probe, including query parameters.
port Number: The port on which to probe endpoints. If unspecified, probes will use the default port of their protocol.
protocol String: The supported protocols available for HTTP 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.