Oracle Cloud Infrastructure

v0.5.0 published on Monday, Sep 12, 2022 by Pulumi

getMonitors

This data source provides the list of Monitors in Oracle Cloud Infrastructure Apm Synthetics service.

Returns a list of monitors.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    var testMonitors = Oci.ApmSynthetics.GetMonitors.Invoke(new()
    {
        ApmDomainId = oci_apm_synthetics_apm_domain.Test_apm_domain.Id,
        DisplayName = @var.Monitor_display_name,
        MonitorType = @var.Monitor_monitor_type,
        ScriptId = oci_apm_synthetics_script.Test_script.Id,
        Status = @var.Monitor_status,
        VantagePoint = @var.Monitor_vantage_point,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ApmSynthetics.GetMonitors(ctx, &apmsynthetics.GetMonitorsArgs{
			ApmDomainId:  oci_apm_synthetics_apm_domain.Test_apm_domain.Id,
			DisplayName:  pulumi.StringRef(_var.Monitor_display_name),
			MonitorType:  pulumi.StringRef(_var.Monitor_monitor_type),
			ScriptId:     pulumi.StringRef(oci_apm_synthetics_script.Test_script.Id),
			Status:       pulumi.StringRef(_var.Monitor_status),
			VantagePoint: pulumi.StringRef(_var.Monitor_vantage_point),
		}, 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.ApmSynthetics.ApmSyntheticsFunctions;
import com.pulumi.oci.ApmSynthetics.inputs.GetMonitorsArgs;
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 testMonitors = ApmSyntheticsFunctions.getMonitors(GetMonitorsArgs.builder()
            .apmDomainId(oci_apm_synthetics_apm_domain.test_apm_domain().id())
            .displayName(var_.monitor_display_name())
            .monitorType(var_.monitor_monitor_type())
            .scriptId(oci_apm_synthetics_script.test_script().id())
            .status(var_.monitor_status())
            .vantagePoint(var_.monitor_vantage_point())
            .build());

    }
}
import pulumi
import pulumi_oci as oci

test_monitors = oci.ApmSynthetics.get_monitors(apm_domain_id=oci_apm_synthetics_apm_domain["test_apm_domain"]["id"],
    display_name=var["monitor_display_name"],
    monitor_type=var["monitor_monitor_type"],
    script_id=oci_apm_synthetics_script["test_script"]["id"],
    status=var["monitor_status"],
    vantage_point=var["monitor_vantage_point"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testMonitors = oci.ApmSynthetics.getMonitors({
    apmDomainId: oci_apm_synthetics_apm_domain.test_apm_domain.id,
    displayName: _var.monitor_display_name,
    monitorType: _var.monitor_monitor_type,
    scriptId: oci_apm_synthetics_script.test_script.id,
    status: _var.monitor_status,
    vantagePoint: _var.monitor_vantage_point,
});
variables:
  testMonitors:
    Fn::Invoke:
      Function: oci:ApmSynthetics:getMonitors
      Arguments:
        apmDomainId: ${oci_apm_synthetics_apm_domain.test_apm_domain.id}
        displayName: ${var.monitor_display_name}
        monitorType: ${var.monitor_monitor_type}
        scriptId: ${oci_apm_synthetics_script.test_script.id}
        status: ${var.monitor_status}
        vantagePoint: ${var.monitor_vantage_point}

Using getMonitors

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 getMonitors(args: GetMonitorsArgs, opts?: InvokeOptions): Promise<GetMonitorsResult>
function getMonitorsOutput(args: GetMonitorsOutputArgs, opts?: InvokeOptions): Output<GetMonitorsResult>
def get_monitors(apm_domain_id: Optional[str] = None,
                 display_name: Optional[str] = None,
                 filters: Optional[Sequence[_apmsynthetics.GetMonitorsFilter]] = None,
                 monitor_type: Optional[str] = None,
                 script_id: Optional[str] = None,
                 status: Optional[str] = None,
                 vantage_point: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetMonitorsResult
def get_monitors_output(apm_domain_id: Optional[pulumi.Input[str]] = None,
                 display_name: Optional[pulumi.Input[str]] = None,
                 filters: Optional[pulumi.Input[Sequence[pulumi.Input[_apmsynthetics.GetMonitorsFilterArgs]]]] = None,
                 monitor_type: Optional[pulumi.Input[str]] = None,
                 script_id: Optional[pulumi.Input[str]] = None,
                 status: Optional[pulumi.Input[str]] = None,
                 vantage_point: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetMonitorsResult]
func GetMonitors(ctx *Context, args *GetMonitorsArgs, opts ...InvokeOption) (*GetMonitorsResult, error)
func GetMonitorsOutput(ctx *Context, args *GetMonitorsOutputArgs, opts ...InvokeOption) GetMonitorsResultOutput

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

public static class GetMonitors 
{
    public static Task<GetMonitorsResult> InvokeAsync(GetMonitorsArgs args, InvokeOptions? opts = null)
    public static Output<GetMonitorsResult> Invoke(GetMonitorsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetMonitorsResult> getMonitors(GetMonitorsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: oci:ApmSynthetics/getMonitors:getMonitors
  arguments:
    # arguments dictionary

The following arguments are supported:

ApmDomainId string

The APM domain ID the request is intended for.

DisplayName string

A filter to return only the resources that match the entire display name.

Filters List<GetMonitorsFilter>
MonitorType string

A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.

ScriptId string

A filter to return only monitors using scriptId.

Status string

A filter to return only monitors that match the status given.

VantagePoint string

The name of the public or dedicated vantage point.

ApmDomainId string

The APM domain ID the request is intended for.

DisplayName string

A filter to return only the resources that match the entire display name.

Filters []GetMonitorsFilter
MonitorType string

A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.

ScriptId string

A filter to return only monitors using scriptId.

Status string

A filter to return only monitors that match the status given.

VantagePoint string

The name of the public or dedicated vantage point.

apmDomainId String

The APM domain ID the request is intended for.

displayName String

A filter to return only the resources that match the entire display name.

filters List<GetMonitorsFilter>
monitorType String

A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.

scriptId String

A filter to return only monitors using scriptId.

status String

A filter to return only monitors that match the status given.

vantagePoint String

The name of the public or dedicated vantage point.

apmDomainId string

The APM domain ID the request is intended for.

displayName string

A filter to return only the resources that match the entire display name.

filters GetMonitorsFilter[]
monitorType string

A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.

scriptId string

A filter to return only monitors using scriptId.

status string

A filter to return only monitors that match the status given.

vantagePoint string

The name of the public or dedicated vantage point.

apm_domain_id str

The APM domain ID the request is intended for.

display_name str

A filter to return only the resources that match the entire display name.

filters GetMonitorsFilter]
monitor_type str

A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.

script_id str

A filter to return only monitors using scriptId.

status str

A filter to return only monitors that match the status given.

vantage_point str

The name of the public or dedicated vantage point.

apmDomainId String

The APM domain ID the request is intended for.

displayName String

A filter to return only the resources that match the entire display name.

filters List<Property Map>
monitorType String

A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.

scriptId String

A filter to return only monitors using scriptId.

status String

A filter to return only monitors that match the status given.

vantagePoint String

The name of the public or dedicated vantage point.

getMonitors Result

The following output properties are available:

ApmDomainId string
Id string

The provider-assigned unique ID for this managed resource.

MonitorCollections List<GetMonitorsMonitorCollection>

The list of monitor_collection.

DisplayName string

Unique name that can be edited. The name should not contain any confidential information.

Filters List<GetMonitorsFilter>
MonitorType string

Type of the monitor.

ScriptId string

The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.

Status string

Enables or disables the monitor.

VantagePoint string
ApmDomainId string
Id string

The provider-assigned unique ID for this managed resource.

MonitorCollections []GetMonitorsMonitorCollection

The list of monitor_collection.

DisplayName string

Unique name that can be edited. The name should not contain any confidential information.

Filters []GetMonitorsFilter
MonitorType string

Type of the monitor.

ScriptId string

The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.

Status string

Enables or disables the monitor.

VantagePoint string
apmDomainId String
id String

The provider-assigned unique ID for this managed resource.

monitorCollections List<GetMonitorsMonitorCollection>

The list of monitor_collection.

displayName String

Unique name that can be edited. The name should not contain any confidential information.

filters List<GetMonitorsFilter>
monitorType String

Type of the monitor.

scriptId String

The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.

status String

Enables or disables the monitor.

vantagePoint String
apmDomainId string
id string

The provider-assigned unique ID for this managed resource.

monitorCollections GetMonitorsMonitorCollection[]

The list of monitor_collection.

displayName string

Unique name that can be edited. The name should not contain any confidential information.

filters GetMonitorsFilter[]
monitorType string

Type of the monitor.

scriptId string

The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.

status string

Enables or disables the monitor.

vantagePoint string
apm_domain_id str
id str

The provider-assigned unique ID for this managed resource.

monitor_collections GetMonitorsMonitorCollection]

The list of monitor_collection.

display_name str

Unique name that can be edited. The name should not contain any confidential information.

filters GetMonitorsFilter]
monitor_type str

Type of the monitor.

script_id str

The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.

status str

Enables or disables the monitor.

vantage_point str
apmDomainId String
id String

The provider-assigned unique ID for this managed resource.

monitorCollections List<Property Map>

The list of monitor_collection.

displayName String

Unique name that can be edited. The name should not contain any confidential information.

filters List<Property Map>
monitorType String

Type of the monitor.

scriptId String

The OCID of the script. scriptId is mandatory for creation of SCRIPTED_BROWSER and SCRIPTED_REST monitor types. For other monitor types, it should be set to null.

status String

Enables or disables the monitor.

vantagePoint String

Supporting Types

GetMonitorsFilter

Name string

Name of the vantage point.

Values List<string>
Regex bool
Name string

Name of the vantage point.

Values []string
Regex bool
name String

Name of the vantage point.

values List<String>
regex Boolean
name string

Name of the vantage point.

values string[]
regex boolean
name str

Name of the vantage point.

values Sequence[str]
regex bool
name String

Name of the vantage point.

values List<String>
regex Boolean

GetMonitorsMonitorCollection

GetMonitorsMonitorCollectionItem

ApmDomainId string

The APM domain ID the request is intended for.

BatchIntervalInSeconds int

Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).

Configurations List<GetMonitorsMonitorCollectionItemConfiguration>

Details of monitor configuration.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DisplayName string

A filter to return only the resources that match the entire display name.

FreeformTags Dictionary<string, object>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Id string

The OCID of the monitor.

IsRunNow bool

If isRunNow is enabled, then the monitor will run now.

IsRunOnce bool

If runOnce is enabled, then the monitor will run once.

MonitorType string

A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.

RepeatIntervalInSeconds int

Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.

SchedulingPolicy string

Scheduling policy on Vantage points.

ScriptId string

A filter to return only monitors using scriptId.

ScriptName string

Name of the script.

ScriptParameters List<GetMonitorsMonitorCollectionItemScriptParameter>

List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]

Status string

A filter to return only monitors that match the status given.

Target string

Specify the endpoint on which to run the monitor. For BROWSER and REST monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is.

TimeCreated string

The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z

TimeUpdated string

The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z

TimeoutInSeconds int

Timeout in seconds. Timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

VantagePointCount int

Number of vantage points where monitor is running.

VantagePoints List<string>

List of public and dedicated vantage points where the monitor is running.

ApmDomainId string

The APM domain ID the request is intended for.

BatchIntervalInSeconds int

Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).

Configurations []GetMonitorsMonitorCollectionItemConfiguration

Details of monitor configuration.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

DisplayName string

A filter to return only the resources that match the entire display name.

FreeformTags map[string]interface{}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

Id string

The OCID of the monitor.

IsRunNow bool

If isRunNow is enabled, then the monitor will run now.

IsRunOnce bool

If runOnce is enabled, then the monitor will run once.

MonitorType string

A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.

RepeatIntervalInSeconds int

Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.

SchedulingPolicy string

Scheduling policy on Vantage points.

ScriptId string

A filter to return only monitors using scriptId.

ScriptName string

Name of the script.

ScriptParameters []GetMonitorsMonitorCollectionItemScriptParameter

List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]

Status string

A filter to return only monitors that match the status given.

Target string

Specify the endpoint on which to run the monitor. For BROWSER and REST monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is.

TimeCreated string

The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z

TimeUpdated string

The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z

TimeoutInSeconds int

Timeout in seconds. Timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

VantagePointCount int

Number of vantage points where monitor is running.

VantagePoints []string

List of public and dedicated vantage points where the monitor is running.

apmDomainId String

The APM domain ID the request is intended for.

batchIntervalInSeconds Integer

Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).

configurations List<GetMonitorsMonitorCollectionItemConfiguration>

Details of monitor configuration.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName String

A filter to return only the resources that match the entire display name.

freeformTags Map<String,Object>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

id String

The OCID of the monitor.

isRunNow Boolean

If isRunNow is enabled, then the monitor will run now.

isRunOnce Boolean

If runOnce is enabled, then the monitor will run once.

monitorType String

A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.

repeatIntervalInSeconds Integer

Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.

schedulingPolicy String

Scheduling policy on Vantage points.

scriptId String

A filter to return only monitors using scriptId.

scriptName String

Name of the script.

scriptParameters List<GetMonitorsMonitorCollectionItemScriptParameter>

List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]

status String

A filter to return only monitors that match the status given.

target String

Specify the endpoint on which to run the monitor. For BROWSER and REST monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is.

timeCreated String

The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z

timeUpdated String

The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z

timeoutInSeconds Integer

Timeout in seconds. Timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

vantagePointCount Integer

Number of vantage points where monitor is running.

vantagePoints List<String>

List of public and dedicated vantage points where the monitor is running.

apmDomainId string

The APM domain ID the request is intended for.

batchIntervalInSeconds number

Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).

configurations GetMonitorsMonitorCollectionItemConfiguration[]

Details of monitor configuration.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName string

A filter to return only the resources that match the entire display name.

freeformTags {[key: string]: any}

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

id string

The OCID of the monitor.

isRunNow boolean

If isRunNow is enabled, then the monitor will run now.

isRunOnce boolean

If runOnce is enabled, then the monitor will run once.

monitorType string

A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.

repeatIntervalInSeconds number

Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.

schedulingPolicy string

Scheduling policy on Vantage points.

scriptId string

A filter to return only monitors using scriptId.

scriptName string

Name of the script.

scriptParameters GetMonitorsMonitorCollectionItemScriptParameter[]

List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]

status string

A filter to return only monitors that match the status given.

target string

Specify the endpoint on which to run the monitor. For BROWSER and REST monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is.

timeCreated string

The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z

timeUpdated string

The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z

timeoutInSeconds number

Timeout in seconds. Timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

vantagePointCount number

Number of vantage points where monitor is running.

vantagePoints string[]

List of public and dedicated vantage points where the monitor is running.

apm_domain_id str

The APM domain ID the request is intended for.

batch_interval_in_seconds int

Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).

configurations GetMonitorsMonitorCollectionItemConfiguration]

Details of monitor configuration.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

display_name str

A filter to return only the resources that match the entire display name.

freeform_tags Mapping[str, Any]

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

id str

The OCID of the monitor.

is_run_now bool

If isRunNow is enabled, then the monitor will run now.

is_run_once bool

If runOnce is enabled, then the monitor will run once.

monitor_type str

A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.

repeat_interval_in_seconds int

Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.

scheduling_policy str

Scheduling policy on Vantage points.

script_id str

A filter to return only monitors using scriptId.

script_name str

Name of the script.

script_parameters GetMonitorsMonitorCollectionItemScriptParameter]

List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]

status str

A filter to return only monitors that match the status given.

target str

Specify the endpoint on which to run the monitor. For BROWSER and REST monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is.

time_created str

The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z

time_updated str

The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z

timeout_in_seconds int

Timeout in seconds. Timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

vantage_point_count int

Number of vantage points where monitor is running.

vantage_points Sequence[str]

List of public and dedicated vantage points where the monitor is running.

apmDomainId String

The APM domain ID the request is intended for.

batchIntervalInSeconds Number

Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).

configurations List<Property Map>

Details of monitor configuration.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}

displayName String

A filter to return only the resources that match the entire display name.

freeformTags Map<Any>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}

id String

The OCID of the monitor.

isRunNow Boolean

If isRunNow is enabled, then the monitor will run now.

isRunOnce Boolean

If runOnce is enabled, then the monitor will run once.

monitorType String

A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.

repeatIntervalInSeconds Number

Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.

schedulingPolicy String

Scheduling policy on Vantage points.

scriptId String

A filter to return only monitors using scriptId.

scriptName String

Name of the script.

scriptParameters List<Property Map>

List of script parameters. Example: [{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]

status String

A filter to return only monitors that match the status given.

target String

Specify the endpoint on which to run the monitor. For BROWSER and REST monitor types, target is mandatory. If target is specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script (specified by scriptId in monitor) against the specified target endpoint. If target is not specified in the SCRIPTED_BROWSER monitor type, then the monitor will run the selected script as it is.

timeCreated String

The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z

timeUpdated String

The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z

timeoutInSeconds Number

Timeout in seconds. Timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. Also, timeoutInSeconds should be a multiple of 60 for Scripted REST, Scripted Browser and Browser monitors. Monitor will be allowed to run only for timeoutInSeconds time. It would be terminated after that.

vantagePointCount Number

Number of vantage points where monitor is running.

vantagePoints List<String>

List of public and dedicated vantage points where the monitor is running.

GetMonitorsMonitorCollectionItemConfiguration

ConfigType string

Type of configuration.

DnsConfigurations List<GetMonitorsMonitorCollectionItemConfigurationDnsConfiguration>

Dns settings.

IsCertificateValidationEnabled bool

If certificate validation is enabled, then the call will fail in case of certification errors.

IsFailureRetried bool

If isFailureRetried is enabled, then a failed call will be retried.

IsRedirectionEnabled bool

If redirection enabled, then redirects will be allowed while accessing target URL.

NetworkConfigurations List<GetMonitorsMonitorCollectionItemConfigurationNetworkConfiguration>

Details of the network configuration.

ReqAuthenticationDetails List<GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetail>

Details for request HTTP authentication.

ReqAuthenticationScheme string

Request http authentication scheme.

RequestHeaders List<GetMonitorsMonitorCollectionItemConfigurationRequestHeader>

List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

RequestMethod string

Request HTTP method.

RequestPostBody string

Request post body content.

RequestQueryParams List<GetMonitorsMonitorCollectionItemConfigurationRequestQueryParam>

List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]

VerifyResponseCodes List<string>

Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.

VerifyResponseContent string

Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.

VerifyTexts List<GetMonitorsMonitorCollectionItemConfigurationVerifyText>

Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.

ConfigType string

Type of configuration.

DnsConfigurations []GetMonitorsMonitorCollectionItemConfigurationDnsConfiguration

Dns settings.

IsCertificateValidationEnabled bool

If certificate validation is enabled, then the call will fail in case of certification errors.

IsFailureRetried bool

If isFailureRetried is enabled, then a failed call will be retried.

IsRedirectionEnabled bool

If redirection enabled, then redirects will be allowed while accessing target URL.

NetworkConfigurations []GetMonitorsMonitorCollectionItemConfigurationNetworkConfiguration

Details of the network configuration.

ReqAuthenticationDetails []GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetail

Details for request HTTP authentication.

ReqAuthenticationScheme string

Request http authentication scheme.

RequestHeaders []GetMonitorsMonitorCollectionItemConfigurationRequestHeader

List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

RequestMethod string

Request HTTP method.

RequestPostBody string

Request post body content.

RequestQueryParams []GetMonitorsMonitorCollectionItemConfigurationRequestQueryParam

List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]

VerifyResponseCodes []string

Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.

VerifyResponseContent string

Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.

VerifyTexts []GetMonitorsMonitorCollectionItemConfigurationVerifyText

Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.

configType String

Type of configuration.

dnsConfigurations List<GetMonitorsMonitorCollectionItemConfigurationDnsConfiguration>

Dns settings.

isCertificateValidationEnabled Boolean

If certificate validation is enabled, then the call will fail in case of certification errors.

isFailureRetried Boolean

If isFailureRetried is enabled, then a failed call will be retried.

isRedirectionEnabled Boolean

If redirection enabled, then redirects will be allowed while accessing target URL.

networkConfigurations List<GetMonitorsMonitorCollectionItemConfigurationNetworkConfiguration>

Details of the network configuration.

reqAuthenticationDetails List<GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetail>

Details for request HTTP authentication.

reqAuthenticationScheme String

Request http authentication scheme.

requestHeaders List<GetMonitorsMonitorCollectionItemConfigurationRequestHeader>

List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

requestMethod String

Request HTTP method.

requestPostBody String

Request post body content.

requestQueryParams List<GetMonitorsMonitorCollectionItemConfigurationRequestQueryParam>

List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]

verifyResponseCodes List<String>

Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.

verifyResponseContent String

Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.

verifyTexts List<GetMonitorsMonitorCollectionItemConfigurationVerifyText>

Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.

configType string

Type of configuration.

dnsConfigurations GetMonitorsMonitorCollectionItemConfigurationDnsConfiguration[]

Dns settings.

isCertificateValidationEnabled boolean

If certificate validation is enabled, then the call will fail in case of certification errors.

isFailureRetried boolean

If isFailureRetried is enabled, then a failed call will be retried.

isRedirectionEnabled boolean

If redirection enabled, then redirects will be allowed while accessing target URL.

networkConfigurations GetMonitorsMonitorCollectionItemConfigurationNetworkConfiguration[]

Details of the network configuration.

reqAuthenticationDetails GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetail[]

Details for request HTTP authentication.

reqAuthenticationScheme string

Request http authentication scheme.

requestHeaders GetMonitorsMonitorCollectionItemConfigurationRequestHeader[]

List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

requestMethod string

Request HTTP method.

requestPostBody string

Request post body content.

requestQueryParams GetMonitorsMonitorCollectionItemConfigurationRequestQueryParam[]

List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]

verifyResponseCodes string[]

Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.

verifyResponseContent string

Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.

verifyTexts GetMonitorsMonitorCollectionItemConfigurationVerifyText[]

Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.

config_type str

Type of configuration.

dns_configurations GetMonitorsMonitorCollectionItemConfigurationDnsConfiguration]

Dns settings.

is_certificate_validation_enabled bool

If certificate validation is enabled, then the call will fail in case of certification errors.

is_failure_retried bool

If isFailureRetried is enabled, then a failed call will be retried.

is_redirection_enabled bool

If redirection enabled, then redirects will be allowed while accessing target URL.

network_configurations GetMonitorsMonitorCollectionItemConfigurationNetworkConfiguration]

Details of the network configuration.

req_authentication_details GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetail]

Details for request HTTP authentication.

req_authentication_scheme str

Request http authentication scheme.

request_headers GetMonitorsMonitorCollectionItemConfigurationRequestHeader]

List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

request_method str

Request HTTP method.

request_post_body str

Request post body content.

request_query_params GetMonitorsMonitorCollectionItemConfigurationRequestQueryParam]

List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]

verify_response_codes Sequence[str]

Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.

verify_response_content str

Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.

verify_texts GetMonitorsMonitorCollectionItemConfigurationVerifyText]

Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.

configType String

Type of configuration.

dnsConfigurations List<Property Map>

Dns settings.

isCertificateValidationEnabled Boolean

If certificate validation is enabled, then the call will fail in case of certification errors.

isFailureRetried Boolean

If isFailureRetried is enabled, then a failed call will be retried.

isRedirectionEnabled Boolean

If redirection enabled, then redirects will be allowed while accessing target URL.

networkConfigurations List<Property Map>

Details of the network configuration.

reqAuthenticationDetails List<Property Map>

Details for request HTTP authentication.

reqAuthenticationScheme String

Request http authentication scheme.

requestHeaders List<Property Map>

List of request headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

requestMethod String

Request HTTP method.

requestPostBody String

Request post body content.

requestQueryParams List<Property Map>

List of request query params. Example: [{"paramName": "sortOrder", "paramValue": "asc"}]

verifyResponseCodes List<String>

Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.

verifyResponseContent String

Verify response content against regular expression based string. If response content does not match the verifyResponseContent value, then it will be considered a failure.

verifyTexts List<Property Map>

Verifies all the search strings present in the response. If any search string is not present in the response, then it will be considered as a failure.

GetMonitorsMonitorCollectionItemConfigurationDnsConfiguration

IsOverrideDns bool

If isOverrideDns is true, then dns will be overridden.

OverrideDnsIp string

Override dns ip value. This value will be honored only if *ref-isOverrideDns is set to true.

IsOverrideDns bool

If isOverrideDns is true, then dns will be overridden.

OverrideDnsIp string

Override dns ip value. This value will be honored only if *ref-isOverrideDns is set to true.

isOverrideDns Boolean

If isOverrideDns is true, then dns will be overridden.

overrideDnsIp String

Override dns ip value. This value will be honored only if *ref-isOverrideDns is set to true.

isOverrideDns boolean

If isOverrideDns is true, then dns will be overridden.

overrideDnsIp string

Override dns ip value. This value will be honored only if *ref-isOverrideDns is set to true.

is_override_dns bool

If isOverrideDns is true, then dns will be overridden.

override_dns_ip str

Override dns ip value. This value will be honored only if *ref-isOverrideDns is set to true.

isOverrideDns Boolean

If isOverrideDns is true, then dns will be overridden.

overrideDnsIp String

Override dns ip value. This value will be honored only if *ref-isOverrideDns is set to true.

GetMonitorsMonitorCollectionItemConfigurationNetworkConfiguration

NumberOfHops int

Number of hops.

ProbeMode string

Type of probe mode when TCP protocol is selected.

ProbePerHop int

Number of probes per hop.

Protocol string

Type of protocol.

TransmissionRate int

Number of probe packets sent out simultaneously.

NumberOfHops int

Number of hops.

ProbeMode string

Type of probe mode when TCP protocol is selected.

ProbePerHop int

Number of probes per hop.

Protocol string

Type of protocol.

TransmissionRate int

Number of probe packets sent out simultaneously.

numberOfHops Integer

Number of hops.

probeMode String

Type of probe mode when TCP protocol is selected.

probePerHop Integer

Number of probes per hop.

protocol String

Type of protocol.

transmissionRate Integer

Number of probe packets sent out simultaneously.

numberOfHops number

Number of hops.

probeMode string

Type of probe mode when TCP protocol is selected.

probePerHop number

Number of probes per hop.

protocol string

Type of protocol.

transmissionRate number

Number of probe packets sent out simultaneously.

number_of_hops int

Number of hops.

probe_mode str

Type of probe mode when TCP protocol is selected.

probe_per_hop int

Number of probes per hop.

protocol str

Type of protocol.

transmission_rate int

Number of probe packets sent out simultaneously.

numberOfHops Number

Number of hops.

probeMode String

Type of probe mode when TCP protocol is selected.

probePerHop Number

Number of probes per hop.

protocol String

Type of protocol.

transmissionRate Number

Number of probe packets sent out simultaneously.

GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetail

AuthHeaders List<GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetailAuthHeader>

List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

AuthRequestMethod string

Request method.

AuthRequestPostBody string

Request post body.

AuthToken string

Authentication token.

AuthUrl string

URL to get authetication token.

AuthUserName string

Username for authentication.

AuthUserPassword string

User password for authentication.

OauthScheme string

Request http oauth scheme.

AuthHeaders []GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetailAuthHeader

List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

AuthRequestMethod string

Request method.

AuthRequestPostBody string

Request post body.

AuthToken string

Authentication token.

AuthUrl string

URL to get authetication token.

AuthUserName string

Username for authentication.

AuthUserPassword string

User password for authentication.

OauthScheme string

Request http oauth scheme.

authHeaders List<GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetailAuthHeader>

List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

authRequestMethod String

Request method.

authRequestPostBody String

Request post body.

authToken String

Authentication token.

authUrl String

URL to get authetication token.

authUserName String

Username for authentication.

authUserPassword String

User password for authentication.

oauthScheme String

Request http oauth scheme.

authHeaders GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetailAuthHeader[]

List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

authRequestMethod string

Request method.

authRequestPostBody string

Request post body.

authToken string

Authentication token.

authUrl string

URL to get authetication token.

authUserName string

Username for authentication.

authUserPassword string

User password for authentication.

oauthScheme string

Request http oauth scheme.

auth_headers GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetailAuthHeader]

List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

auth_request_method str

Request method.

auth_request_post_body str

Request post body.

auth_token str

Authentication token.

auth_url str

URL to get authetication token.

auth_user_name str

Username for authentication.

auth_user_password str

User password for authentication.

oauth_scheme str

Request http oauth scheme.

authHeaders List<Property Map>

List of authentication headers. Example: [{"headerName": "content-type", "headerValue":"json"}]

authRequestMethod String

Request method.

authRequestPostBody String

Request post body.

authToken String

Authentication token.

authUrl String

URL to get authetication token.

authUserName String

Username for authentication.

authUserPassword String

User password for authentication.

oauthScheme String

Request http oauth scheme.

GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetailAuthHeader

HeaderName string

Name of the header.

HeaderValue string

Value of the header.

HeaderName string

Name of the header.

HeaderValue string

Value of the header.

headerName String

Name of the header.

headerValue String

Value of the header.

headerName string

Name of the header.

headerValue string

Value of the header.

header_name str

Name of the header.

header_value str

Value of the header.

headerName String

Name of the header.

headerValue String

Value of the header.

GetMonitorsMonitorCollectionItemConfigurationRequestHeader

HeaderName string

Name of the header.

HeaderValue string

Value of the header.

HeaderName string

Name of the header.

HeaderValue string

Value of the header.

headerName String

Name of the header.

headerValue String

Value of the header.

headerName string

Name of the header.

headerValue string

Value of the header.

header_name str

Name of the header.

header_value str

Value of the header.

headerName String

Name of the header.

headerValue String

Value of the header.

GetMonitorsMonitorCollectionItemConfigurationRequestQueryParam

ParamName string

Name of the parameter.

ParamValue string

Value of the parameter.

ParamName string

Name of the parameter.

ParamValue string

Value of the parameter.

paramName String

Name of the parameter.

paramValue String

Value of the parameter.

paramName string

Name of the parameter.

paramValue string

Value of the parameter.

param_name str

Name of the parameter.

param_value str

Value of the parameter.

paramName String

Name of the parameter.

paramValue String

Value of the parameter.

GetMonitorsMonitorCollectionItemConfigurationVerifyText

Text string

Verification text in the response.

Text string

Verification text in the response.

text String

Verification text in the response.

text string

Verification text in the response.

text str

Verification text in the response.

text String

Verification text in the response.

GetMonitorsMonitorCollectionItemScriptParameter

IsOverwritten bool

If parameter value is default or overwritten.

IsSecret bool

Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.

MonitorScriptParameters List<GetMonitorsMonitorCollectionItemScriptParameterMonitorScriptParameter>

Details of the script parameter that can be used to overwrite the parameter present in the script.

ParamName string

Name of the parameter.

ParamValue string

Value of the parameter.

IsOverwritten bool

If parameter value is default or overwritten.

IsSecret bool

Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.

MonitorScriptParameters []GetMonitorsMonitorCollectionItemScriptParameterMonitorScriptParameter

Details of the script parameter that can be used to overwrite the parameter present in the script.

ParamName string

Name of the parameter.

ParamValue string

Value of the parameter.

isOverwritten Boolean

If parameter value is default or overwritten.

isSecret Boolean

Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.

monitorScriptParameters List<GetMonitorsMonitorCollectionItemScriptParameterMonitorScriptParameter>

Details of the script parameter that can be used to overwrite the parameter present in the script.

paramName String

Name of the parameter.

paramValue String

Value of the parameter.

isOverwritten boolean

If parameter value is default or overwritten.

isSecret boolean

Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.

monitorScriptParameters GetMonitorsMonitorCollectionItemScriptParameterMonitorScriptParameter[]

Details of the script parameter that can be used to overwrite the parameter present in the script.

paramName string

Name of the parameter.

paramValue string

Value of the parameter.

is_overwritten bool

If parameter value is default or overwritten.

is_secret bool

Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.

monitor_script_parameters GetMonitorsMonitorCollectionItemScriptParameterMonitorScriptParameter]

Details of the script parameter that can be used to overwrite the parameter present in the script.

param_name str

Name of the parameter.

param_value str

Value of the parameter.

isOverwritten Boolean

If parameter value is default or overwritten.

isSecret Boolean

Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.

monitorScriptParameters List<Property Map>

Details of the script parameter that can be used to overwrite the parameter present in the script.

paramName String

Name of the parameter.

paramValue String

Value of the parameter.

GetMonitorsMonitorCollectionItemScriptParameterMonitorScriptParameter

ParamName string

Name of the parameter.

ParamValue string

Value of the parameter.

ParamName string

Name of the parameter.

ParamValue string

Value of the parameter.

paramName String

Name of the parameter.

paramValue String

Value of the parameter.

paramName string

Name of the parameter.

paramValue string

Value of the parameter.

param_name str

Name of the parameter.

param_value str

Value of the parameter.

paramName String

Name of the parameter.

paramValue String

Value of the parameter.

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.