oci.ApmSynthetics.getMonitors
Explore with Pulumi AI
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 System.Linq;
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,
IsMaintenanceWindowActive = @var.Monitor_is_maintenance_window_active,
IsMaintenanceWindowSet = @var.Monitor_is_maintenance_window_set,
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),
IsMaintenanceWindowActive: pulumi.BoolRef(_var.Monitor_is_maintenance_window_active),
IsMaintenanceWindowSet: pulumi.BoolRef(_var.Monitor_is_maintenance_window_set),
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())
.isMaintenanceWindowActive(var_.monitor_is_maintenance_window_active())
.isMaintenanceWindowSet(var_.monitor_is_maintenance_window_set())
.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=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
display_name=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
is_maintenance_window_active=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
is_maintenance_window_set=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
monitor_type=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
script_id=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
status=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
vantage_point=%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
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,
isMaintenanceWindowActive: _var.monitor_is_maintenance_window_active,
isMaintenanceWindowSet: _var.monitor_is_maintenance_window_set,
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}
isMaintenanceWindowActive: ${var.monitor_is_maintenance_window_active}
isMaintenanceWindowSet: ${var.monitor_is_maintenance_window_set}
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,
is_maintenance_window_active: Optional[bool] = None,
is_maintenance_window_set: Optional[bool] = 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,
is_maintenance_window_active: Optional[pulumi.Input[bool]] = None,
is_maintenance_window_set: Optional[pulumi.Input[bool]] = 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:
- Apm
Domain stringId The APM domain ID the request is intended for.
- Display
Name string A filter to return only the resources that match the entire display name.
- Filters
List<Get
Monitors Filter> - Is
Maintenance boolWindow Active A filter to return the monitors whose maintenance window is currently active.
- Is
Maintenance boolWindow Set A filter to return the monitors whose maintenance window is set.
- Monitor
Type string A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.
- Script
Id string A filter to return only monitors using scriptId.
- Status string
A filter to return only monitors that match the status given.
- Vantage
Point string The name of the public or dedicated vantage point.
- Apm
Domain stringId The APM domain ID the request is intended for.
- Display
Name string A filter to return only the resources that match the entire display name.
- Filters
[]Get
Monitors Filter - Is
Maintenance boolWindow Active A filter to return the monitors whose maintenance window is currently active.
- Is
Maintenance boolWindow Set A filter to return the monitors whose maintenance window is set.
- Monitor
Type string A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.
- Script
Id string A filter to return only monitors using scriptId.
- Status string
A filter to return only monitors that match the status given.
- Vantage
Point string The name of the public or dedicated vantage point.
- apm
Domain StringId The APM domain ID the request is intended for.
- display
Name String A filter to return only the resources that match the entire display name.
- filters
List<Get
Monitors Filter> - is
Maintenance BooleanWindow Active A filter to return the monitors whose maintenance window is currently active.
- is
Maintenance BooleanWindow Set A filter to return the monitors whose maintenance window is set.
- monitor
Type String A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.
- script
Id String A filter to return only monitors using scriptId.
- status String
A filter to return only monitors that match the status given.
- vantage
Point String The name of the public or dedicated vantage point.
- apm
Domain stringId The APM domain ID the request is intended for.
- display
Name string A filter to return only the resources that match the entire display name.
- filters
Get
Monitors Filter[] - is
Maintenance booleanWindow Active A filter to return the monitors whose maintenance window is currently active.
- is
Maintenance booleanWindow Set A filter to return the monitors whose maintenance window is set.
- monitor
Type string A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.
- script
Id string A filter to return only monitors using scriptId.
- status string
A filter to return only monitors that match the status given.
- vantage
Point string The name of the public or dedicated vantage point.
- apm_
domain_ strid 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
Get
Monitors Filter] - is_
maintenance_ boolwindow_ active A filter to return the monitors whose maintenance window is currently active.
- is_
maintenance_ boolwindow_ set A filter to return the monitors whose maintenance window is set.
- 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.
- apm
Domain StringId The APM domain ID the request is intended for.
- display
Name String A filter to return only the resources that match the entire display name.
- filters List<Property Map>
- is
Maintenance BooleanWindow Active A filter to return the monitors whose maintenance window is currently active.
- is
Maintenance BooleanWindow Set A filter to return the monitors whose maintenance window is set.
- monitor
Type String A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.
- script
Id String A filter to return only monitors using scriptId.
- status String
A filter to return only monitors that match the status given.
- vantage
Point String The name of the public or dedicated vantage point.
getMonitors Result
The following output properties are available:
- Apm
Domain stringId - Id string
The provider-assigned unique ID for this managed resource.
- Monitor
Collections List<GetMonitors Monitor Collection> The list of monitor_collection.
- Display
Name string Unique name that can be edited. The name should not contain any confidential information.
- Filters
List<Get
Monitors Filter> - Is
Maintenance boolWindow Active - Is
Maintenance boolWindow Set - Monitor
Type string Type of the monitor.
- Script
Id 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.
- Vantage
Point string
- Apm
Domain stringId - Id string
The provider-assigned unique ID for this managed resource.
- Monitor
Collections []GetMonitors Monitor Collection The list of monitor_collection.
- Display
Name string Unique name that can be edited. The name should not contain any confidential information.
- Filters
[]Get
Monitors Filter - Is
Maintenance boolWindow Active - Is
Maintenance boolWindow Set - Monitor
Type string Type of the monitor.
- Script
Id 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.
- Vantage
Point string
- apm
Domain StringId - id String
The provider-assigned unique ID for this managed resource.
- monitor
Collections List<GetMonitors Monitor Collection> The list of monitor_collection.
- display
Name String Unique name that can be edited. The name should not contain any confidential information.
- filters
List<Get
Monitors Filter> - is
Maintenance BooleanWindow Active - is
Maintenance BooleanWindow Set - monitor
Type String Type of the monitor.
- script
Id 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.
- vantage
Point String
- apm
Domain stringId - id string
The provider-assigned unique ID for this managed resource.
- monitor
Collections GetMonitors Monitor Collection[] The list of monitor_collection.
- display
Name string Unique name that can be edited. The name should not contain any confidential information.
- filters
Get
Monitors Filter[] - is
Maintenance booleanWindow Active - is
Maintenance booleanWindow Set - monitor
Type string Type of the monitor.
- script
Id 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.
- vantage
Point string
- apm_
domain_ strid - id str
The provider-assigned unique ID for this managed resource.
- monitor_
collections GetMonitors Monitor Collection] The list of monitor_collection.
- display_
name str Unique name that can be edited. The name should not contain any confidential information.
- filters
Get
Monitors Filter] - is_
maintenance_ boolwindow_ active - is_
maintenance_ boolwindow_ set - 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
- apm
Domain StringId - id String
The provider-assigned unique ID for this managed resource.
- monitor
Collections List<Property Map> The list of monitor_collection.
- display
Name String Unique name that can be edited. The name should not contain any confidential information.
- filters List<Property Map>
- is
Maintenance BooleanWindow Active - is
Maintenance BooleanWindow Set - monitor
Type String Type of the monitor.
- script
Id 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.
- vantage
Point String
Supporting Types
GetMonitorsFilter
GetMonitorsMonitorCollection
GetMonitorsMonitorCollectionItem
- Apm
Domain stringId The APM domain ID the request is intended for.
- Availability
Configurations List<GetMonitors Monitor Collection Item Availability Configuration> Monitor availability configuration details.
- Batch
Interval intIn Seconds Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).
- Configurations
List<Get
Monitors Monitor Collection Item Configuration> Details of monitor configuration.
- Dictionary<string, object>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Display
Name string A filter to return only the resources that match the entire display name.
- 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.
- Is
Run boolNow If isRunNow is enabled, then the monitor will run now.
- Is
Run boolOnce If runOnce is enabled, then the monitor will run once.
- Maintenance
Window List<GetSchedules Monitors Monitor Collection Item Maintenance Window Schedule> Details used to schedule maintenance window.
- Monitor
Type string A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.
- Repeat
Interval intIn Seconds 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 string Scheduling policy on Vantage points.
- Script
Id string A filter to return only monitors using scriptId.
- Script
Name string Name of the script.
- Script
Parameters List<GetMonitors Monitor Collection Item Script Parameter> 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.
- Time
Created string The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- Time
Updated string The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- Timeout
In intSeconds Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% 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 intCount Number of vantage points where monitor is running.
- Vantage
Points List<string> List of public and dedicated vantage points where the monitor is running.
- Apm
Domain stringId The APM domain ID the request is intended for.
- Availability
Configurations []GetMonitors Monitor Collection Item Availability Configuration Monitor availability configuration details.
- Batch
Interval intIn Seconds Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).
- Configurations
[]Get
Monitors Monitor Collection Item Configuration Details of monitor configuration.
- map[string]interface{}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Display
Name string A filter to return only the resources that match the entire display name.
- 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.
- Is
Run boolNow If isRunNow is enabled, then the monitor will run now.
- Is
Run boolOnce If runOnce is enabled, then the monitor will run once.
- Maintenance
Window []GetSchedules Monitors Monitor Collection Item Maintenance Window Schedule Details used to schedule maintenance window.
- Monitor
Type string A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.
- Repeat
Interval intIn Seconds 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 string Scheduling policy on Vantage points.
- Script
Id string A filter to return only monitors using scriptId.
- Script
Name string Name of the script.
- Script
Parameters []GetMonitors Monitor Collection Item Script Parameter 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.
- Time
Created string The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- Time
Updated string The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- Timeout
In intSeconds Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% 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 intCount Number of vantage points where monitor is running.
- Vantage
Points []string List of public and dedicated vantage points where the monitor is running.
- apm
Domain StringId The APM domain ID the request is intended for.
- availability
Configurations List<GetMonitors Monitor Collection Item Availability Configuration> Monitor availability configuration details.
- batch
Interval IntegerIn Seconds Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).
- configurations
List<Get
Monitors Monitor Collection Item Configuration> Details of monitor configuration.
- Map<String,Object>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name String A filter to return only the resources that match the entire display name.
- 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.
- is
Run BooleanNow If isRunNow is enabled, then the monitor will run now.
- is
Run BooleanOnce If runOnce is enabled, then the monitor will run once.
- maintenance
Window List<GetSchedules Monitors Monitor Collection Item Maintenance Window Schedule> Details used to schedule maintenance window.
- monitor
Type String A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.
- repeat
Interval IntegerIn Seconds 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 String Scheduling policy on Vantage points.
- script
Id String A filter to return only monitors using scriptId.
- script
Name String Name of the script.
- script
Parameters List<GetMonitors Monitor Collection Item Script Parameter> 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.
- time
Created String The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Updated String The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- timeout
In IntegerSeconds Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% 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 IntegerCount Number of vantage points where monitor is running.
- vantage
Points List<String> List of public and dedicated vantage points where the monitor is running.
- apm
Domain stringId The APM domain ID the request is intended for.
- availability
Configurations GetMonitors Monitor Collection Item Availability Configuration[] Monitor availability configuration details.
- batch
Interval numberIn Seconds Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).
- configurations
Get
Monitors Monitor Collection Item Configuration[] Details of monitor configuration.
- {[key: string]: any}
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name string A filter to return only the resources that match the entire display name.
- {[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.
- is
Run booleanNow If isRunNow is enabled, then the monitor will run now.
- is
Run booleanOnce If runOnce is enabled, then the monitor will run once.
- maintenance
Window GetSchedules Monitors Monitor Collection Item Maintenance Window Schedule[] Details used to schedule maintenance window.
- monitor
Type string A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.
- repeat
Interval numberIn Seconds 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 string Scheduling policy on Vantage points.
- script
Id string A filter to return only monitors using scriptId.
- script
Name string Name of the script.
- script
Parameters GetMonitors Monitor Collection Item Script Parameter[] 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.
- time
Created string The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Updated string The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- timeout
In numberSeconds Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% 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 numberCount Number of vantage points where monitor is running.
- vantage
Points string[] List of public and dedicated vantage points where the monitor is running.
- apm_
domain_ strid The APM domain ID the request is intended for.
- availability_
configurations GetMonitors Monitor Collection Item Availability Configuration] Monitor availability configuration details.
- batch_
interval_ intin_ seconds Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).
- configurations
Get
Monitors Monitor Collection Item Configuration] Details of monitor configuration.
- 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.
- 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_ boolnow If isRunNow is enabled, then the monitor will run now.
- is_
run_ boolonce If runOnce is enabled, then the monitor will run once.
- maintenance_
window_ Getschedules Monitors Monitor Collection Item Maintenance Window Schedule] Details used to schedule maintenance window.
- 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_ intin_ seconds 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 GetMonitors Monitor Collection Item Script Parameter] 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_ intseconds Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% 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_ intcount Number of vantage points where monitor is running.
- vantage_
points Sequence[str] List of public and dedicated vantage points where the monitor is running.
- apm
Domain StringId The APM domain ID the request is intended for.
- availability
Configurations List<Property Map> Monitor availability configuration details.
- batch
Interval NumberIn Seconds Time interval between 2 runs in round robin batch mode (*SchedulingPolicy - BATCHED_ROUND_ROBIN).
- configurations List<Property Map>
Details of monitor configuration.
- Map<Any>
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name String A filter to return only the resources that match the entire display name.
- 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.
- is
Run BooleanNow If isRunNow is enabled, then the monitor will run now.
- is
Run BooleanOnce If runOnce is enabled, then the monitor will run once.
- maintenance
Window List<Property Map>Schedules Details used to schedule maintenance window.
- monitor
Type String A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST and REST.
- repeat
Interval NumberIn Seconds 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 String Scheduling policy on Vantage points.
- script
Id String A filter to return only monitors using scriptId.
- script
Name String Name of the script.
- script
Parameters 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.
- time
Created String The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Updated String The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- timeout
In NumberSeconds Timeout in seconds. If isFailureRetried is true, then timeout cannot be more than 30% of repeatIntervalInSeconds time for monitors. If isFailureRetried is false, then timeout cannot be more than 50% 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 NumberCount Number of vantage points where monitor is running.
- vantage
Points List<String> List of public and dedicated vantage points where the monitor is running.
GetMonitorsMonitorCollectionItemAvailabilityConfiguration
- Max
Allowed intFailures Per Interval Intervals with failed runs more than this value will be classified as UNAVAILABLE.
- Min
Allowed intRuns Per Interval Intervals with runs less than this value will be classified as UNKNOWN and excluded from the availability calculations.
- Max
Allowed intFailures Per Interval Intervals with failed runs more than this value will be classified as UNAVAILABLE.
- Min
Allowed intRuns Per Interval Intervals with runs less than this value will be classified as UNKNOWN and excluded from the availability calculations.
- max
Allowed IntegerFailures Per Interval Intervals with failed runs more than this value will be classified as UNAVAILABLE.
- min
Allowed IntegerRuns Per Interval Intervals with runs less than this value will be classified as UNKNOWN and excluded from the availability calculations.
- max
Allowed numberFailures Per Interval Intervals with failed runs more than this value will be classified as UNAVAILABLE.
- min
Allowed numberRuns Per Interval Intervals with runs less than this value will be classified as UNKNOWN and excluded from the availability calculations.
- max_
allowed_ intfailures_ per_ interval Intervals with failed runs more than this value will be classified as UNAVAILABLE.
- min_
allowed_ intruns_ per_ interval Intervals with runs less than this value will be classified as UNKNOWN and excluded from the availability calculations.
- max
Allowed NumberFailures Per Interval Intervals with failed runs more than this value will be classified as UNAVAILABLE.
- min
Allowed NumberRuns Per Interval Intervals with runs less than this value will be classified as UNKNOWN and excluded from the availability calculations.
GetMonitorsMonitorCollectionItemConfiguration
- Config
Type string Type of configuration.
- Dns
Configurations List<GetMonitors Monitor Collection Item Configuration Dns Configuration> Dns settings.
- Is
Certificate boolValidation Enabled If certificate validation is enabled, then the call will fail in case of certification errors.
- Is
Failure boolRetried If isFailureRetried is enabled, then a failed call will be retried.
- Is
Redirection boolEnabled If redirection enabled, then redirects will be allowed while accessing target URL.
- Network
Configurations List<GetMonitors Monitor Collection Item Configuration Network Configuration> Details of the network configuration.
- Req
Authentication List<GetDetails Monitors Monitor Collection Item Configuration Req Authentication Detail> Details for request HTTP authentication.
- Req
Authentication stringScheme Request http authentication scheme.
- Request
Headers List<GetMonitors Monitor Collection Item Configuration Request Header> List of request headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- Request
Method string Request HTTP method.
- Request
Post stringBody Request post body content.
- Request
Query List<GetParams Monitors Monitor Collection Item Configuration Request Query Param> List of request query params. Example:
[{"paramName": "sortOrder", "paramValue": "asc"}]
- Verify
Response List<string>Codes Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- Verify
Response stringContent 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 List<GetMonitors Monitor Collection Item Configuration Verify Text> 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 string Type of configuration.
- Dns
Configurations []GetMonitors Monitor Collection Item Configuration Dns Configuration Dns settings.
- Is
Certificate boolValidation Enabled If certificate validation is enabled, then the call will fail in case of certification errors.
- Is
Failure boolRetried If isFailureRetried is enabled, then a failed call will be retried.
- Is
Redirection boolEnabled If redirection enabled, then redirects will be allowed while accessing target URL.
- Network
Configurations []GetMonitors Monitor Collection Item Configuration Network Configuration Details of the network configuration.
- Req
Authentication []GetDetails Monitors Monitor Collection Item Configuration Req Authentication Detail Details for request HTTP authentication.
- Req
Authentication stringScheme Request http authentication scheme.
- Request
Headers []GetMonitors Monitor Collection Item Configuration Request Header List of request headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- Request
Method string Request HTTP method.
- Request
Post stringBody Request post body content.
- Request
Query []GetParams Monitors Monitor Collection Item Configuration Request Query Param List of request query params. Example:
[{"paramName": "sortOrder", "paramValue": "asc"}]
- Verify
Response []stringCodes Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- Verify
Response stringContent 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 []GetMonitors Monitor Collection Item Configuration Verify Text 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 String Type of configuration.
- dns
Configurations List<GetMonitors Monitor Collection Item Configuration Dns Configuration> Dns settings.
- is
Certificate BooleanValidation Enabled If certificate validation is enabled, then the call will fail in case of certification errors.
- is
Failure BooleanRetried If isFailureRetried is enabled, then a failed call will be retried.
- is
Redirection BooleanEnabled If redirection enabled, then redirects will be allowed while accessing target URL.
- network
Configurations List<GetMonitors Monitor Collection Item Configuration Network Configuration> Details of the network configuration.
- req
Authentication List<GetDetails Monitors Monitor Collection Item Configuration Req Authentication Detail> Details for request HTTP authentication.
- req
Authentication StringScheme Request http authentication scheme.
- request
Headers List<GetMonitors Monitor Collection Item Configuration Request Header> List of request headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- request
Method String Request HTTP method.
- request
Post StringBody Request post body content.
- request
Query List<GetParams Monitors Monitor Collection Item Configuration Request Query Param> List of request query params. Example:
[{"paramName": "sortOrder", "paramValue": "asc"}]
- verify
Response List<String>Codes Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- verify
Response StringContent 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 List<GetMonitors Monitor Collection Item Configuration Verify Text> 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 string Type of configuration.
- dns
Configurations GetMonitors Monitor Collection Item Configuration Dns Configuration[] Dns settings.
- is
Certificate booleanValidation Enabled If certificate validation is enabled, then the call will fail in case of certification errors.
- is
Failure booleanRetried If isFailureRetried is enabled, then a failed call will be retried.
- is
Redirection booleanEnabled If redirection enabled, then redirects will be allowed while accessing target URL.
- network
Configurations GetMonitors Monitor Collection Item Configuration Network Configuration[] Details of the network configuration.
- req
Authentication GetDetails Monitors Monitor Collection Item Configuration Req Authentication Detail[] Details for request HTTP authentication.
- req
Authentication stringScheme Request http authentication scheme.
- request
Headers GetMonitors Monitor Collection Item Configuration Request Header[] List of request headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- request
Method string Request HTTP method.
- request
Post stringBody Request post body content.
- request
Query GetParams Monitors Monitor Collection Item Configuration Request Query Param[] List of request query params. Example:
[{"paramName": "sortOrder", "paramValue": "asc"}]
- verify
Response string[]Codes Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- verify
Response stringContent 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 GetMonitors Monitor Collection Item Configuration Verify Text[] 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 GetMonitors Monitor Collection Item Configuration Dns Configuration] Dns settings.
- is_
certificate_ boolvalidation_ enabled If certificate validation is enabled, then the call will fail in case of certification errors.
- is_
failure_ boolretried If isFailureRetried is enabled, then a failed call will be retried.
- is_
redirection_ boolenabled If redirection enabled, then redirects will be allowed while accessing target URL.
- network_
configurations GetMonitors Monitor Collection Item Configuration Network Configuration] Details of the network configuration.
- req_
authentication_ Getdetails Monitors Monitor Collection Item Configuration Req Authentication Detail] Details for request HTTP authentication.
- req_
authentication_ strscheme Request http authentication scheme.
- request_
headers GetMonitors Monitor Collection Item Configuration Request Header] List of request headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- request_
method str Request HTTP method.
- request_
post_ strbody Request post body content.
- request_
query_ Getparams Monitors Monitor Collection Item Configuration Request Query Param] List of request query params. Example:
[{"paramName": "sortOrder", "paramValue": "asc"}]
- verify_
response_ Sequence[str]codes Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- verify_
response_ strcontent 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 GetMonitors Monitor Collection Item Configuration Verify Text] 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 String Type of configuration.
- dns
Configurations List<Property Map> Dns settings.
- is
Certificate BooleanValidation Enabled If certificate validation is enabled, then the call will fail in case of certification errors.
- is
Failure BooleanRetried If isFailureRetried is enabled, then a failed call will be retried.
- is
Redirection BooleanEnabled If redirection enabled, then redirects will be allowed while accessing target URL.
- network
Configurations List<Property Map> Details of the network configuration.
- req
Authentication List<Property Map>Details Details for request HTTP authentication.
- req
Authentication StringScheme Request http authentication scheme.
- request
Headers List<Property Map> List of request headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- request
Method String Request HTTP method.
- request
Post StringBody Request post body content.
- request
Query List<Property Map>Params List of request query params. Example:
[{"paramName": "sortOrder", "paramValue": "asc"}]
- verify
Response List<String>Codes Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- verify
Response StringContent 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 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
- Is
Override boolDns If isOverrideDns is true, then dns will be overridden.
- Override
Dns stringIp Override dns ip value. This value will be honored only if *ref-isOverrideDns is set to true.
- Is
Override boolDns If isOverrideDns is true, then dns will be overridden.
- Override
Dns stringIp Override dns ip value. This value will be honored only if *ref-isOverrideDns is set to true.
- is
Override BooleanDns If isOverrideDns is true, then dns will be overridden.
- override
Dns StringIp Override dns ip value. This value will be honored only if *ref-isOverrideDns is set to true.
- is
Override booleanDns If isOverrideDns is true, then dns will be overridden.
- override
Dns stringIp Override dns ip value. This value will be honored only if *ref-isOverrideDns is set to true.
- is_
override_ booldns If isOverrideDns is true, then dns will be overridden.
- override_
dns_ strip Override dns ip value. This value will be honored only if *ref-isOverrideDns is set to true.
- is
Override BooleanDns If isOverrideDns is true, then dns will be overridden.
- override
Dns StringIp Override dns ip value. This value will be honored only if *ref-isOverrideDns is set to true.
GetMonitorsMonitorCollectionItemConfigurationNetworkConfiguration
- Number
Of intHops Number of hops.
- Probe
Mode string Type of probe mode when TCP protocol is selected.
- Probe
Per intHop Number of probes per hop.
- Protocol string
Type of protocol.
- Transmission
Rate int Number of probe packets sent out simultaneously.
- Number
Of intHops Number of hops.
- Probe
Mode string Type of probe mode when TCP protocol is selected.
- Probe
Per intHop Number of probes per hop.
- Protocol string
Type of protocol.
- Transmission
Rate int Number of probe packets sent out simultaneously.
- number
Of IntegerHops Number of hops.
- probe
Mode String Type of probe mode when TCP protocol is selected.
- probe
Per IntegerHop Number of probes per hop.
- protocol String
Type of protocol.
- transmission
Rate Integer Number of probe packets sent out simultaneously.
- number
Of numberHops Number of hops.
- probe
Mode string Type of probe mode when TCP protocol is selected.
- probe
Per numberHop Number of probes per hop.
- protocol string
Type of protocol.
- transmission
Rate number Number of probe packets sent out simultaneously.
- number_
of_ inthops Number of hops.
- probe_
mode str Type of probe mode when TCP protocol is selected.
- probe_
per_ inthop Number of probes per hop.
- protocol str
Type of protocol.
- transmission_
rate int Number of probe packets sent out simultaneously.
- number
Of NumberHops Number of hops.
- probe
Mode String Type of probe mode when TCP protocol is selected.
- probe
Per NumberHop Number of probes per hop.
- protocol String
Type of protocol.
- transmission
Rate Number Number of probe packets sent out simultaneously.
GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetail
- Auth
Headers List<GetMonitors Monitor Collection Item Configuration Req Authentication Detail Auth Header> List of authentication headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- Auth
Request stringMethod Request method.
- Auth
Request stringPost Body Request post body.
- Auth
Token string Authentication token.
- Auth
Url string URL to get authetication token.
- Auth
User stringName Username for authentication.
- Auth
User stringPassword User password for authentication.
- Oauth
Scheme string Request http oauth scheme.
- Auth
Headers []GetMonitors Monitor Collection Item Configuration Req Authentication Detail Auth Header List of authentication headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- Auth
Request stringMethod Request method.
- Auth
Request stringPost Body Request post body.
- Auth
Token string Authentication token.
- Auth
Url string URL to get authetication token.
- Auth
User stringName Username for authentication.
- Auth
User stringPassword User password for authentication.
- Oauth
Scheme string Request http oauth scheme.
- auth
Headers List<GetMonitors Monitor Collection Item Configuration Req Authentication Detail Auth Header> List of authentication headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- auth
Request StringMethod Request method.
- auth
Request StringPost Body Request post body.
- auth
Token String Authentication token.
- auth
Url String URL to get authetication token.
- auth
User StringName Username for authentication.
- auth
User StringPassword User password for authentication.
- oauth
Scheme String Request http oauth scheme.
- auth
Headers GetMonitors Monitor Collection Item Configuration Req Authentication Detail Auth Header[] List of authentication headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- auth
Request stringMethod Request method.
- auth
Request stringPost Body Request post body.
- auth
Token string Authentication token.
- auth
Url string URL to get authetication token.
- auth
User stringName Username for authentication.
- auth
User stringPassword User password for authentication.
- oauth
Scheme string Request http oauth scheme.
- auth_
headers GetMonitors Monitor Collection Item Configuration Req Authentication Detail Auth Header] List of authentication headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- auth_
request_ strmethod Request method.
- auth_
request_ strpost_ body Request post body.
- auth_
token str Authentication token.
- auth_
url str URL to get authetication token.
- auth_
user_ strname Username for authentication.
- auth_
user_ strpassword User password for authentication.
- oauth_
scheme str Request http oauth scheme.
- auth
Headers List<Property Map> List of authentication headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- auth
Request StringMethod Request method.
- auth
Request StringPost Body Request post body.
- auth
Token String Authentication token.
- auth
Url String URL to get authetication token.
- auth
User StringName Username for authentication.
- auth
User StringPassword User password for authentication.
- oauth
Scheme String Request http oauth scheme.
GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetailAuthHeader
- Header
Name string Name of the header.
- Header
Value string Value of the header.
- Header
Name string Name of the header.
- Header
Value string Value of the header.
- header
Name String Name of the header.
- header
Value String Value of the header.
- header
Name string Name of the header.
- header
Value string Value of the header.
- header_
name str Name of the header.
- header_
value str Value of the header.
- header
Name String Name of the header.
- header
Value String Value of the header.
GetMonitorsMonitorCollectionItemConfigurationRequestHeader
- Header
Name string Name of the header.
- Header
Value string Value of the header.
- Header
Name string Name of the header.
- Header
Value string Value of the header.
- header
Name String Name of the header.
- header
Value String Value of the header.
- header
Name string Name of the header.
- header
Value string Value of the header.
- header_
name str Name of the header.
- header_
value str Value of the header.
- header
Name String Name of the header.
- header
Value String Value of the header.
GetMonitorsMonitorCollectionItemConfigurationRequestQueryParam
- Param
Name string Name of the parameter.
- Param
Value string Value of the parameter.
- Param
Name string Name of the parameter.
- Param
Value string Value of the parameter.
- param
Name String Name of the parameter.
- param
Value String Value of the parameter.
- param
Name string Name of the parameter.
- param
Value string Value of the parameter.
- param_
name str Name of the parameter.
- param_
value str Value of the parameter.
- param
Name String Name of the parameter.
- param
Value 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.
GetMonitorsMonitorCollectionItemMaintenanceWindowSchedule
- Time
Ended string End time for the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- Time
Started string Start time for the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- Time
Ended string End time for the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- Time
Started string Start time for the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Ended String End time for the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Started String Start time for the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Ended string End time for the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Started string Start time for the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time_
ended str End time for the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time_
started str Start time for the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Ended String End time for the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Started String Start time for the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
GetMonitorsMonitorCollectionItemScriptParameter
- 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 List<GetParameters Monitors Monitor Collection Item Script Parameter Monitor Script Parameter> Details of the script parameter that can be used to overwrite the parameter present in the script.
- Param
Name string Name of the parameter.
- Param
Value 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 []GetParameters Monitors Monitor Collection Item Script Parameter Monitor Script Parameter Details of the script parameter that can be used to overwrite the parameter present in the script.
- Param
Name string Name of the parameter.
- Param
Value string Value of the parameter.
- is
Overwritten Boolean If parameter value is default or overwritten.
- is
Secret Boolean Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
- monitor
Script List<GetParameters Monitors Monitor Collection Item Script Parameter Monitor Script Parameter> Details of the script parameter that can be used to overwrite the parameter present in the script.
- param
Name String Name of the parameter.
- param
Value String Value of the parameter.
- is
Overwritten boolean If parameter value is default or overwritten.
- is
Secret boolean Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
- monitor
Script GetParameters Monitors Monitor Collection Item Script Parameter Monitor Script Parameter[] Details of the script parameter that can be used to overwrite the parameter present in the script.
- param
Name string Name of the parameter.
- param
Value 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_ Getparameters Monitors Monitor Collection Item Script Parameter Monitor Script Parameter] 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.
- is
Overwritten Boolean If parameter value is default or overwritten.
- is
Secret Boolean Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
- monitor
Script List<Property Map>Parameters Details of the script parameter that can be used to overwrite the parameter present in the script.
- param
Name String Name of the parameter.
- param
Value String Value of the parameter.
GetMonitorsMonitorCollectionItemScriptParameterMonitorScriptParameter
- Param
Name string Name of the parameter.
- Param
Value string Value of the parameter.
- Param
Name string Name of the parameter.
- Param
Value string Value of the parameter.
- param
Name String Name of the parameter.
- param
Value String Value of the parameter.
- param
Name string Name of the parameter.
- param
Value string Value of the parameter.
- param_
name str Name of the parameter.
- param_
value str Value of the parameter.
- param
Name String Name of the parameter.
- param
Value String Value of the parameter.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.