Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getMonitor

This data source provides details about a specific Monitor resource in Oracle Cloud Infrastructure Apm Synthetics service.

Gets the configuration of the monitor identified by the OCID.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testMonitor = Output.Create(Oci.ApmSynthetics.GetMonitor.InvokeAsync(new Oci.ApmSynthetics.GetMonitorArgs
        {
            ApmDomainId = oci_apm_synthetics_apm_domain.Test_apm_domain.Id,
            MonitorId = oci_apm_synthetics_monitor.Test_monitor.Id,
        }));
    }

}
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.GetMonitor(ctx, &apmsynthetics.GetMonitorArgs{
			ApmDomainId: oci_apm_synthetics_apm_domain.Test_apm_domain.Id,
			MonitorId:   oci_apm_synthetics_monitor.Test_monitor.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_monitor = oci.ApmSynthetics.get_monitor(apm_domain_id=oci_apm_synthetics_apm_domain["test_apm_domain"]["id"],
    monitor_id=oci_apm_synthetics_monitor["test_monitor"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testMonitor = oci.ApmSynthetics.getMonitor({
    apmDomainId: oci_apm_synthetics_apm_domain.test_apm_domain.id,
    monitorId: oci_apm_synthetics_monitor.test_monitor.id,
});

Coming soon!

Using getMonitor

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 getMonitor(args: GetMonitorArgs, opts?: InvokeOptions): Promise<GetMonitorResult>
function getMonitorOutput(args: GetMonitorOutputArgs, opts?: InvokeOptions): Output<GetMonitorResult>
def get_monitor(apm_domain_id: Optional[str] = None,
                monitor_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetMonitorResult
def get_monitor_output(apm_domain_id: Optional[pulumi.Input[str]] = None,
                monitor_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetMonitorResult]
func GetMonitor(ctx *Context, args *GetMonitorArgs, opts ...InvokeOption) (*GetMonitorResult, error)
func GetMonitorOutput(ctx *Context, args *GetMonitorOutputArgs, opts ...InvokeOption) GetMonitorResultOutput

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

public static class GetMonitor 
{
    public static Task<GetMonitorResult> InvokeAsync(GetMonitorArgs args, InvokeOptions? opts = null)
    public static Output<GetMonitorResult> Invoke(GetMonitorInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetMonitorResult> getMonitor(GetMonitorArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:ApmSynthetics/getMonitor:getMonitor
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ApmDomainId string

The APM domain ID the request is intended for.

MonitorId string

The OCID of the monitor.

ApmDomainId string

The APM domain ID the request is intended for.

MonitorId string

The OCID of the monitor.

apmDomainId String

The APM domain ID the request is intended for.

monitorId String

The OCID of the monitor.

apmDomainId string

The APM domain ID the request is intended for.

monitorId string

The OCID of the monitor.

apm_domain_id str

The APM domain ID the request is intended for.

monitor_id str

The OCID of the monitor.

apmDomainId String

The APM domain ID the request is intended for.

monitorId String

The OCID of the monitor.

getMonitor Result

The following output properties are available:

ApmDomainId string
Configurations List<GetMonitorConfiguration>

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

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

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.

IsRunOnce bool

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

MonitorId string
MonitorType string

Type of the monitor.

RepeatIntervalInSeconds int

Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.

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.

ScriptName string

Name of the script.

ScriptParameters List<GetMonitorScriptParameter>

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

Status string

Enables or disables the monitor.

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. 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 vantage points from where monitor is running.

ApmDomainId string
Configurations []GetMonitorConfiguration

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

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

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.

IsRunOnce bool

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

MonitorId string
MonitorType string

Type of the monitor.

RepeatIntervalInSeconds int

Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.

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.

ScriptName string

Name of the script.

ScriptParameters []GetMonitorScriptParameter

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

Status string

Enables or disables the monitor.

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. 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 vantage points from where monitor is running.

apmDomainId String
configurations List<GetMonitorConfiguration>

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

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

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.

isRunOnce Boolean

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

monitorId String
monitorType String

Type of the monitor.

repeatIntervalInSeconds Integer

Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.

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.

scriptName String

Name of the script.

scriptParameters List<GetMonitorScriptParameter>

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

status String

Enables or disables the monitor.

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. 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 vantage points from where monitor is running.

apmDomainId string
configurations GetMonitorConfiguration[]

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

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

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.

isRunOnce boolean

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

monitorId string
monitorType string

Type of the monitor.

repeatIntervalInSeconds number

Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.

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.

scriptName string

Name of the script.

scriptParameters GetMonitorScriptParameter[]

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

status string

Enables or disables the monitor.

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. 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 vantage points from where monitor is running.

apm_domain_id str
configurations GetMonitorConfiguration]

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

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

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_once bool

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

monitor_id str
monitor_type str

Type of the monitor.

repeat_interval_in_seconds int

Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.

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.

script_name str

Name of the script.

script_parameters GetMonitorScriptParameter]

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

status str

Enables or disables the monitor.

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. 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 vantage points from where monitor is running.

apmDomainId String
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

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

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.

isRunOnce Boolean

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

monitorId String
monitorType String

Type of the monitor.

repeatIntervalInSeconds Number

Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds.

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.

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

Enables or disables the monitor.

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. 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 vantage points from where monitor is running.

Supporting Types

GetMonitorConfiguration

ConfigType string

Type of configuration.

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<GetMonitorConfigurationNetworkConfiguration>

Details of the network configuration.

ReqAuthenticationDetails List<GetMonitorConfigurationReqAuthenticationDetail>

Details for request HTTP authentication.

ReqAuthenticationScheme string

Request http authentication scheme.

RequestHeaders List<GetMonitorConfigurationRequestHeader>

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

RequestMethod string

Request HTTP method.

RequestPostBody string

Request post body content.

RequestQueryParams List<GetMonitorConfigurationRequestQueryParam>

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<GetMonitorConfigurationVerifyText>

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

ConfigType string

Type of configuration.

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 []GetMonitorConfigurationNetworkConfiguration

Details of the network configuration.

ReqAuthenticationDetails []GetMonitorConfigurationReqAuthenticationDetail

Details for request HTTP authentication.

ReqAuthenticationScheme string

Request http authentication scheme.

RequestHeaders []GetMonitorConfigurationRequestHeader

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

RequestMethod string

Request HTTP method.

RequestPostBody string

Request post body content.

RequestQueryParams []GetMonitorConfigurationRequestQueryParam

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 []GetMonitorConfigurationVerifyText

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

configType String

Type of configuration.

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<GetMonitorConfigurationNetworkConfiguration>

Details of the network configuration.

reqAuthenticationDetails List<GetMonitorConfigurationReqAuthenticationDetail>

Details for request HTTP authentication.

reqAuthenticationScheme String

Request http authentication scheme.

requestHeaders List<GetMonitorConfigurationRequestHeader>

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

requestMethod String

Request HTTP method.

requestPostBody String

Request post body content.

requestQueryParams List<GetMonitorConfigurationRequestQueryParam>

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<GetMonitorConfigurationVerifyText>

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

configType string

Type of configuration.

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 GetMonitorConfigurationNetworkConfiguration[]

Details of the network configuration.

reqAuthenticationDetails GetMonitorConfigurationReqAuthenticationDetail[]

Details for request HTTP authentication.

reqAuthenticationScheme string

Request http authentication scheme.

requestHeaders GetMonitorConfigurationRequestHeader[]

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

requestMethod string

Request HTTP method.

requestPostBody string

Request post body content.

requestQueryParams GetMonitorConfigurationRequestQueryParam[]

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 GetMonitorConfigurationVerifyText[]

Verify all the search strings present in 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.

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 GetMonitorConfigurationNetworkConfiguration]

Details of the network configuration.

req_authentication_details GetMonitorConfigurationReqAuthenticationDetail]

Details for request HTTP authentication.

req_authentication_scheme str

Request http authentication scheme.

request_headers GetMonitorConfigurationRequestHeader]

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 GetMonitorConfigurationRequestQueryParam]

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 GetMonitorConfigurationVerifyText]

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

configType String

Type of configuration.

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>

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

GetMonitorConfigurationNetworkConfiguration

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.

GetMonitorConfigurationReqAuthenticationDetail

AuthHeaders List<GetMonitorConfigurationReqAuthenticationDetailAuthHeader>

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 []GetMonitorConfigurationReqAuthenticationDetailAuthHeader

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<GetMonitorConfigurationReqAuthenticationDetailAuthHeader>

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 GetMonitorConfigurationReqAuthenticationDetailAuthHeader[]

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 GetMonitorConfigurationReqAuthenticationDetailAuthHeader]

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.

GetMonitorConfigurationReqAuthenticationDetailAuthHeader

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.

GetMonitorConfigurationRequestHeader

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.

GetMonitorConfigurationRequestQueryParam

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.

GetMonitorConfigurationVerifyText

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.

GetMonitorScriptParameter

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<GetMonitorScriptParameterMonitorScriptParameter>

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 []GetMonitorScriptParameterMonitorScriptParameter

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<GetMonitorScriptParameterMonitorScriptParameter>

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 GetMonitorScriptParameterMonitorScriptParameter[]

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 GetMonitorScriptParameterMonitorScriptParameter]

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.

GetMonitorScriptParameterMonitorScriptParameter

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.