Oracle Cloud Infrastructure v0.12.0, Mar 17 23

oci.HealthChecks.getHttpMonitor

This data source provides details about a specific Http Monitor resource in Oracle Cloud Infrastructure Health Checks service.

Gets the configuration for the specified monitor.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testHttpMonitor = Oci.HealthChecks.GetHttpMonitor.Invoke(new()
    {
        MonitorId = oci_apm_synthetics_monitor.Test_monitor.Id,
    });

});

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.GetHttpMonitor(ctx, &healthchecks.GetHttpMonitorArgs{
			MonitorId: oci_apm_synthetics_monitor.Test_monitor.Id,
		}, 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.GetHttpMonitorArgs;
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 testHttpMonitor = HealthChecksFunctions.getHttpMonitor(GetHttpMonitorArgs.builder()
            .monitorId(oci_apm_synthetics_monitor.test_monitor().id())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_http_monitor = oci.HealthChecks.get_http_monitor(monitor_id=oci_apm_synthetics_monitor["test_monitor"]["id"])

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

const testHttpMonitor = oci.HealthChecks.getHttpMonitor({
    monitorId: oci_apm_synthetics_monitor.test_monitor.id,
});

variables:
  testHttpMonitor:
    fn::invoke:
      Function: oci:HealthChecks:getHttpMonitor
      Arguments:
        monitorId: ${oci_apm_synthetics_monitor.test_monitor.id}

Using getHttpMonitor

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 getHttpMonitor(args: GetHttpMonitorArgs, opts?: InvokeOptions): Promise<GetHttpMonitorResult>
function getHttpMonitorOutput(args: GetHttpMonitorOutputArgs, opts?: InvokeOptions): Output<GetHttpMonitorResult>

def get_http_monitor(monitor_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetHttpMonitorResult
def get_http_monitor_output(monitor_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetHttpMonitorResult]

func GetHttpMonitor(ctx *Context, args *GetHttpMonitorArgs, opts ...InvokeOption) (*GetHttpMonitorResult, error)
func GetHttpMonitorOutput(ctx *Context, args *GetHttpMonitorOutputArgs, opts ...InvokeOption) GetHttpMonitorResultOutput

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

public static class GetHttpMonitor 
{
    public static Task<GetHttpMonitorResult> InvokeAsync(GetHttpMonitorArgs args, InvokeOptions? opts = null)
    public static Output<GetHttpMonitorResult> Invoke(GetHttpMonitorInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetHttpMonitorResult> getHttpMonitor(GetHttpMonitorArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

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

The following arguments are supported:

MonitorId string: The OCID of a monitor.

MonitorId string: The OCID of a monitor.

monitorId String: The OCID of a monitor.

monitorId string: The OCID of a monitor.

monitor_id str: The OCID of a monitor.

monitorId String: The OCID of a monitor.

getHttpMonitor Result

The following output properties are available:

CompartmentId string: The OCID of the 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: A user-friendly and mutable name suitable for display in a user interface.
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: The region where updates must be made and where results must be fetched from.
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.
MonitorId string
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: The OCID of the 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: A user-friendly and mutable name suitable for display in a user interface.
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: The region where updates must be made and where results must be fetched from.
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.
MonitorId string
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: The OCID of the 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: A user-friendly and mutable name suitable for display in a user interface.
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: The region where updates must be made and where results must be fetched from.
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.
monitorId String
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: The OCID of the 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: A user-friendly and mutable name suitable for display in a user interface.
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: The region where updates must be made and where results must be fetched from.
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.
monitorId string
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: The OCID of the 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: A user-friendly and mutable name suitable for display in a user interface.
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: The region where updates must be made and where results must be fetched from.
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.
monitor_id str
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: The OCID of the 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: A user-friendly and mutable name suitable for display in a user interface.
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: The region where updates must be made and where results must be fetched from.
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.
monitorId String
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.

oci.HealthChecks.getHttpMonitor

Example Usage

Using getHttpMonitor

getHttpMonitor Result

Package Details

Contents