Oracle Cloud Infrastructure v2.29.0 published on Wednesday, Apr 9, 2025 by Pulumi
oci.ApmSynthetics.getMonitors
Explore with Pulumi AI
This data source provides the list of Monitors in Oracle Cloud Infrastructure APM Availability Monitoring service (aka APM Synthetics Service).
Returns a list of monitors.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testMonitors = oci.ApmSynthetics.getMonitors({
apmDomainId: testApmDomain.id,
displayName: monitorDisplayName,
isMaintenanceWindowActive: monitorIsMaintenanceWindowActive,
isMaintenanceWindowSet: monitorIsMaintenanceWindowSet,
monitorType: monitorMonitorType,
scriptId: testScript.id,
status: monitorStatus,
vantagePoint: monitorVantagePoint,
});
import pulumi
import pulumi_oci as oci
test_monitors = oci.ApmSynthetics.get_monitors(apm_domain_id=test_apm_domain["id"],
display_name=monitor_display_name,
is_maintenance_window_active=monitor_is_maintenance_window_active,
is_maintenance_window_set=monitor_is_maintenance_window_set,
monitor_type=monitor_monitor_type,
script_id=test_script["id"],
status=monitor_status,
vantage_point=monitor_vantage_point)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v2/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: testApmDomain.Id,
DisplayName: pulumi.StringRef(monitorDisplayName),
IsMaintenanceWindowActive: pulumi.BoolRef(monitorIsMaintenanceWindowActive),
IsMaintenanceWindowSet: pulumi.BoolRef(monitorIsMaintenanceWindowSet),
MonitorType: pulumi.StringRef(monitorMonitorType),
ScriptId: pulumi.StringRef(testScript.Id),
Status: pulumi.StringRef(monitorStatus),
VantagePoint: pulumi.StringRef(monitorVantagePoint),
}, nil)
if err != nil {
return err
}
return nil
})
}
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 = testApmDomain.Id,
DisplayName = monitorDisplayName,
IsMaintenanceWindowActive = monitorIsMaintenanceWindowActive,
IsMaintenanceWindowSet = monitorIsMaintenanceWindowSet,
MonitorType = monitorMonitorType,
ScriptId = testScript.Id,
Status = monitorStatus,
VantagePoint = monitorVantagePoint,
});
});
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(testApmDomain.id())
.displayName(monitorDisplayName)
.isMaintenanceWindowActive(monitorIsMaintenanceWindowActive)
.isMaintenanceWindowSet(monitorIsMaintenanceWindowSet)
.monitorType(monitorMonitorType)
.scriptId(testScript.id())
.status(monitorStatus)
.vantagePoint(monitorVantagePoint)
.build());
}
}
variables:
testMonitors:
fn::invoke:
function: oci:ApmSynthetics:getMonitors
arguments:
apmDomainId: ${testApmDomain.id}
displayName: ${monitorDisplayName}
isMaintenanceWindowActive: ${monitorIsMaintenanceWindowActive}
isMaintenanceWindowSet: ${monitorIsMaintenanceWindowSet}
monitorType: ${monitorMonitorType}
scriptId: ${testScript.id}
status: ${monitorStatus}
vantagePoint: ${monitorVantagePoint}
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)
public static Output<GetMonitorsResult> getMonitors(GetMonitorsArgs args, InvokeOptions options)
fn::invoke:
function: oci:ApmSynthetics/getMonitors:getMonitors
arguments:
# arguments dictionary
The following arguments are supported:
- Apm
Domain Id This property is required. string - 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
Changes to this property will trigger replacement.
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, REST, NETWORK, DNS, FTP and SQL.
- 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 Id This property is required. string - 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
Changes to this property will trigger replacement.
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, REST, NETWORK, DNS, FTP and SQL.
- 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 Id This property is required. String - 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
Changes to this property will trigger replacement.
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, REST, NETWORK, DNS, FTP and SQL.
- 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 Id This property is required. string - 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
Changes to this property will trigger replacement.
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, REST, NETWORK, DNS, FTP and SQL.
- 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_ id This property is required. str - The APM domain ID the request is intended for.
- display_
name str - A filter to return only the resources that match the entire display name.
- filters
Changes to this property will trigger replacement.
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, REST, NETWORK, DNS, FTP and SQL.
- 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 Id This property is required. String - 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
Changes to this property will trigger replacement.
- 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, REST, NETWORK, DNS, FTP and SQL.
- 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 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 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 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 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 Sequence[apmsynthetics.Get Monitors 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
Sequence[apmsynthetics.
Get Monitors Filter] - is_
maintenance_ boolwindow_ active - is_
maintenance_ boolwindow_ set - monitor_
type str - Type of 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 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
- Items
This property is required. List<GetMonitors Monitor Collection Item>
- Items
This property is required. []GetMonitors Monitor Collection Item
- items
This property is required. List<GetMonitors Monitor Collection Item>
- items
This property is required. GetMonitors Monitor Collection Item[]
- items
This property is required. Sequence[apmsynthetics.Get Monitors Monitor Collection Item]
- items
This property is required. List<Property Map>
GetMonitorsMonitorCollectionItem
- Apm
Domain Id This property is required. string - The APM domain ID the request is intended for.
- Availability
Configurations This property is required. List<GetMonitors Monitor Collection Item Availability Configuration> - Monitor availability configuration details.
- Batch
Interval In Seconds This property is required. int - Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
- Configurations
This property is required. List<GetMonitors Monitor Collection Item Configuration> - Details of monitor configuration.
- Created
By This property is required. string - Name of the user that created the monitor.
This property is required. Dictionary<string, string>- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Display
Name This property is required. string - A filter to return only the resources that match the entire display name.
This property is required. Dictionary<string, string>- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- Id
This property is required. string - The OCID of the monitor.
- Is
Ipv6 This property is required. bool - If enabled, domain name will resolve to an IPv6 address.
- Is
Run Now This property is required. bool - If isRunNow is enabled, then the monitor will run immediately.
- Is
Run Once This property is required. bool - If runOnce is enabled, then the monitor will run once.
- Last
Updated By This property is required. string - Name of the user that recently updated the monitor.
- Maintenance
Window Schedules This property is required. List<GetMonitors Monitor Collection Item Maintenance Window Schedule> - Details required to schedule maintenance window.
- Monitor
Type This property is required. string - A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST, NETWORK, DNS, FTP and SQL.
- Repeat
Interval In Seconds This property is required. int - Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
- Scheduling
Policy This property is required. string - Scheduling policy to decide the distribution of monitor executions on vantage points.
- Script
Id This property is required. string - A filter to return only monitors using scriptId.
- Script
Name This property is required. string - Name of the script.
- Script
Parameters This property is required. List<GetMonitors Monitor Collection Item Script Parameter> - List of script parameters. Example:
[{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
- Status
This property is required. string - A filter to return only monitors that match the status given.
- Target
This property is required. string - Specify the endpoint on which to run the monitor. For BROWSER, REST, NETWORK, DNS and FTP 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. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80.
- Time
Created This property is required. string - The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- Time
Updated This property is required. string - The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- Timeout
In Seconds This property is required. int - 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 Count This property is required. int - Number of vantage points where monitor is running.
- Vantage
Points This property is required. List<GetMonitors Monitor Collection Item Vantage Point> - List of public, dedicated and onPremise vantage points where the monitor is running.
- Apm
Domain Id This property is required. string - The APM domain ID the request is intended for.
- Availability
Configurations This property is required. []GetMonitors Monitor Collection Item Availability Configuration - Monitor availability configuration details.
- Batch
Interval In Seconds This property is required. int - Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
- Configurations
This property is required. []GetMonitors Monitor Collection Item Configuration - Details of monitor configuration.
- Created
By This property is required. string - Name of the user that created the monitor.
This property is required. map[string]string- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Display
Name This property is required. string - A filter to return only the resources that match the entire display name.
This property is required. map[string]string- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- Id
This property is required. string - The OCID of the monitor.
- Is
Ipv6 This property is required. bool - If enabled, domain name will resolve to an IPv6 address.
- Is
Run Now This property is required. bool - If isRunNow is enabled, then the monitor will run immediately.
- Is
Run Once This property is required. bool - If runOnce is enabled, then the monitor will run once.
- Last
Updated By This property is required. string - Name of the user that recently updated the monitor.
- Maintenance
Window Schedules This property is required. []GetMonitors Monitor Collection Item Maintenance Window Schedule - Details required to schedule maintenance window.
- Monitor
Type This property is required. string - A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST, NETWORK, DNS, FTP and SQL.
- Repeat
Interval In Seconds This property is required. int - Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
- Scheduling
Policy This property is required. string - Scheduling policy to decide the distribution of monitor executions on vantage points.
- Script
Id This property is required. string - A filter to return only monitors using scriptId.
- Script
Name This property is required. string - Name of the script.
- Script
Parameters This property is required. []GetMonitors Monitor Collection Item Script Parameter - List of script parameters. Example:
[{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
- Status
This property is required. string - A filter to return only monitors that match the status given.
- Target
This property is required. string - Specify the endpoint on which to run the monitor. For BROWSER, REST, NETWORK, DNS and FTP 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. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80.
- Time
Created This property is required. string - The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- Time
Updated This property is required. string - The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- Timeout
In Seconds This property is required. int - 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 Count This property is required. int - Number of vantage points where monitor is running.
- Vantage
Points This property is required. []GetMonitors Monitor Collection Item Vantage Point - List of public, dedicated and onPremise vantage points where the monitor is running.
- apm
Domain Id This property is required. String - The APM domain ID the request is intended for.
- availability
Configurations This property is required. List<GetMonitors Monitor Collection Item Availability Configuration> - Monitor availability configuration details.
- batch
Interval In Seconds This property is required. Integer - Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
- configurations
This property is required. List<GetMonitors Monitor Collection Item Configuration> - Details of monitor configuration.
- created
By This property is required. String - Name of the user that created the monitor.
This property is required. Map<String,String>- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name This property is required. String - A filter to return only the resources that match the entire display name.
This property is required. Map<String,String>- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- id
This property is required. String - The OCID of the monitor.
- is
Ipv6 This property is required. Boolean - If enabled, domain name will resolve to an IPv6 address.
- is
Run Now This property is required. Boolean - If isRunNow is enabled, then the monitor will run immediately.
- is
Run Once This property is required. Boolean - If runOnce is enabled, then the monitor will run once.
- last
Updated By This property is required. String - Name of the user that recently updated the monitor.
- maintenance
Window Schedules This property is required. List<GetMonitors Monitor Collection Item Maintenance Window Schedule> - Details required to schedule maintenance window.
- monitor
Type This property is required. String - A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST, NETWORK, DNS, FTP and SQL.
- repeat
Interval In Seconds This property is required. Integer - Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
- scheduling
Policy This property is required. String - Scheduling policy to decide the distribution of monitor executions on vantage points.
- script
Id This property is required. String - A filter to return only monitors using scriptId.
- script
Name This property is required. String - Name of the script.
- script
Parameters This property is required. List<GetMonitors Monitor Collection Item Script Parameter> - List of script parameters. Example:
[{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
- status
This property is required. String - A filter to return only monitors that match the status given.
- target
This property is required. String - Specify the endpoint on which to run the monitor. For BROWSER, REST, NETWORK, DNS and FTP 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. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80.
- time
Created This property is required. String - The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Updated This property is required. String - The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- timeout
In Seconds This property is required. Integer - 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 Count This property is required. Integer - Number of vantage points where monitor is running.
- vantage
Points This property is required. List<GetMonitors Monitor Collection Item Vantage Point> - List of public, dedicated and onPremise vantage points where the monitor is running.
- apm
Domain Id This property is required. string - The APM domain ID the request is intended for.
- availability
Configurations This property is required. GetMonitors Monitor Collection Item Availability Configuration[] - Monitor availability configuration details.
- batch
Interval In Seconds This property is required. number - Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
- configurations
This property is required. GetMonitors Monitor Collection Item Configuration[] - Details of monitor configuration.
- created
By This property is required. string - Name of the user that created the monitor.
This property is required. {[key: string]: string}- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name This property is required. string - A filter to return only the resources that match the entire display name.
This property is required. {[key: string]: string}- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- id
This property is required. string - The OCID of the monitor.
- is
Ipv6 This property is required. boolean - If enabled, domain name will resolve to an IPv6 address.
- is
Run Now This property is required. boolean - If isRunNow is enabled, then the monitor will run immediately.
- is
Run Once This property is required. boolean - If runOnce is enabled, then the monitor will run once.
- last
Updated By This property is required. string - Name of the user that recently updated the monitor.
- maintenance
Window Schedules This property is required. GetMonitors Monitor Collection Item Maintenance Window Schedule[] - Details required to schedule maintenance window.
- monitor
Type This property is required. string - A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST, NETWORK, DNS, FTP and SQL.
- repeat
Interval In Seconds This property is required. number - Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
- scheduling
Policy This property is required. string - Scheduling policy to decide the distribution of monitor executions on vantage points.
- script
Id This property is required. string - A filter to return only monitors using scriptId.
- script
Name This property is required. string - Name of the script.
- script
Parameters This property is required. GetMonitors Monitor Collection Item Script Parameter[] - List of script parameters. Example:
[{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
- status
This property is required. string - A filter to return only monitors that match the status given.
- target
This property is required. string - Specify the endpoint on which to run the monitor. For BROWSER, REST, NETWORK, DNS and FTP 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. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80.
- time
Created This property is required. string - The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Updated This property is required. string - The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- timeout
In Seconds This property is required. number - 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 Count This property is required. number - Number of vantage points where monitor is running.
- vantage
Points This property is required. GetMonitors Monitor Collection Item Vantage Point[] - List of public, dedicated and onPremise vantage points where the monitor is running.
- apm_
domain_ id This property is required. str - The APM domain ID the request is intended for.
- availability_
configurations This property is required. Sequence[apmsynthetics.Get Monitors Monitor Collection Item Availability Configuration] - Monitor availability configuration details.
- batch_
interval_ in_ seconds This property is required. int - Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
- configurations
This property is required. Sequence[apmsynthetics.Get Monitors Monitor Collection Item Configuration] - Details of monitor configuration.
- created_
by This property is required. str - Name of the user that created the monitor.
This property is required. Mapping[str, str]- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display_
name This property is required. str - A filter to return only the resources that match the entire display name.
This property is required. Mapping[str, str]- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- id
This property is required. str - The OCID of the monitor.
- is_
ipv6 This property is required. bool - If enabled, domain name will resolve to an IPv6 address.
- is_
run_ now This property is required. bool - If isRunNow is enabled, then the monitor will run immediately.
- is_
run_ once This property is required. bool - If runOnce is enabled, then the monitor will run once.
- last_
updated_ by This property is required. str - Name of the user that recently updated the monitor.
- maintenance_
window_ schedules This property is required. Sequence[apmsynthetics.Get Monitors Monitor Collection Item Maintenance Window Schedule] - Details required to schedule maintenance window.
- monitor_
type This property is required. str - A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST, NETWORK, DNS, FTP and SQL.
- repeat_
interval_ in_ seconds This property is required. int - Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
- scheduling_
policy This property is required. str - Scheduling policy to decide the distribution of monitor executions on vantage points.
- script_
id This property is required. str - A filter to return only monitors using scriptId.
- script_
name This property is required. str - Name of the script.
- script_
parameters This property is required. Sequence[apmsynthetics.Get Monitors Monitor Collection Item Script Parameter] - List of script parameters. Example:
[{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
- status
This property is required. str - A filter to return only monitors that match the status given.
- target
This property is required. str - Specify the endpoint on which to run the monitor. For BROWSER, REST, NETWORK, DNS and FTP 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. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80.
- time_
created This property is required. str - The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time_
updated This property is required. str - The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- timeout_
in_ seconds This property is required. int - 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_ count This property is required. int - Number of vantage points where monitor is running.
- vantage_
points This property is required. Sequence[apmsynthetics.Get Monitors Monitor Collection Item Vantage Point] - List of public, dedicated and onPremise vantage points where the monitor is running.
- apm
Domain Id This property is required. String - The APM domain ID the request is intended for.
- availability
Configurations This property is required. List<Property Map> - Monitor availability configuration details.
- batch
Interval In Seconds This property is required. Number - Time interval between two runs in round robin batch mode (SchedulingPolicy - BATCHED_ROUND_ROBIN).
- configurations
This property is required. List<Property Map> - Details of monitor configuration.
- created
By This property is required. String - Name of the user that created the monitor.
This property is required. Map<String>- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- display
Name This property is required. String - A filter to return only the resources that match the entire display name.
This property is required. Map<String>- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- id
This property is required. String - The OCID of the monitor.
- is
Ipv6 This property is required. Boolean - If enabled, domain name will resolve to an IPv6 address.
- is
Run Now This property is required. Boolean - If isRunNow is enabled, then the monitor will run immediately.
- is
Run Once This property is required. Boolean - If runOnce is enabled, then the monitor will run once.
- last
Updated By This property is required. String - Name of the user that recently updated the monitor.
- maintenance
Window Schedules This property is required. List<Property Map> - Details required to schedule maintenance window.
- monitor
Type This property is required. String - A filter to return only monitors that match the given monitor type. Supported values are SCRIPTED_BROWSER, BROWSER, SCRIPTED_REST, REST, NETWORK, DNS, FTP and SQL.
- repeat
Interval In Seconds This property is required. Number - Interval in seconds after the start time when the job should be repeated. Minimum repeatIntervalInSeconds should be 300 seconds for Scripted REST, Scripted Browser and Browser monitors, and 60 seconds for REST monitor.
- scheduling
Policy This property is required. String - Scheduling policy to decide the distribution of monitor executions on vantage points.
- script
Id This property is required. String - A filter to return only monitors using scriptId.
- script
Name This property is required. String - Name of the script.
- script
Parameters This property is required. List<Property Map> - List of script parameters. Example:
[{"monitorScriptParameter": {"paramName": "userid", "paramValue":"testuser"}, "isSecret": false, "isOverwritten": false}]
- status
This property is required. String - A filter to return only monitors that match the status given.
- target
This property is required. String - Specify the endpoint on which to run the monitor. For BROWSER, REST, NETWORK, DNS and FTP 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. For NETWORK monitor with TCP protocol, a port needs to be provided along with target. Example: 192.168.0.1:80.
- time
Created This property is required. String - The time the resource was created, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Updated This property is required. String - The time the resource was updated, expressed in RFC 3339 timestamp format. Example:
2020-02-13T22:47:12.613Z
- timeout
In Seconds This property is required. Number - 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 Count This property is required. Number - Number of vantage points where monitor is running.
- vantage
Points This property is required. List<Property Map> - List of public, dedicated and onPremise vantage points where the monitor is running.
GetMonitorsMonitorCollectionItemAvailabilityConfiguration
- Max
Allowed Failures Per Interval This property is required. int - Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
- Min
Allowed Runs Per Interval This property is required. int - Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
- Max
Allowed Failures Per Interval This property is required. int - Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
- Min
Allowed Runs Per Interval This property is required. int - Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
- max
Allowed Failures Per Interval This property is required. Integer - Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
- min
Allowed Runs Per Interval This property is required. Integer - Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
- max
Allowed Failures Per Interval This property is required. number - Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
- min
Allowed Runs Per Interval This property is required. number - Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
- max_
allowed_ failures_ per_ interval This property is required. int - Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
- min_
allowed_ runs_ per_ interval This property is required. int - Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
- max
Allowed Failures Per Interval This property is required. Number - Maximum number of failed runs allowed in an interval. If an interval has more failed runs than the specified value, then the interval will be classified as UNAVAILABLE.
- min
Allowed Runs Per Interval This property is required. Number - Minimum number of runs allowed in an interval. If an interval has fewer runs than the specified value, then the interval will be classified as UNKNOWN and will be excluded from the availability calculations.
GetMonitorsMonitorCollectionItemConfiguration
- Client
Certificate Details This property is required. List<GetMonitors Monitor Collection Item Configuration Client Certificate Detail> - Details for client certificate.
- Config
Type This property is required. string - Type of configuration.
- Connection
String This property is required. string - Database connection string.
- Database
Authentication Details This property is required. List<GetMonitors Monitor Collection Item Configuration Database Authentication Detail> - Details for basic authentication.
- Database
Connection Type This property is required. string - Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type.
- Database
Role This property is required. string - Database role.
- Database
Type This property is required. string - Database type.
- Database
Wallet Details This property is required. List<GetMonitors Monitor Collection Item Configuration Database Wallet Detail> - Details for database wallet.
- Dns
Configurations This property is required. List<GetMonitors Monitor Collection Item Configuration Dns Configuration> - Information about the DNS settings.
- Download
Size Limit In Bytes This property is required. int - Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.
- Ftp
Basic Authentication Details This property is required. List<GetMonitors Monitor Collection Item Configuration Ftp Basic Authentication Detail> - Details for basic authentication.
- Ftp
Protocol This property is required. string - FTP protocol type.
- Ftp
Request Type This property is required. string - FTP monitor request type.
- Is
Active Mode This property is required. bool - If enabled, Active mode will be used for the FTP connection.
- Is
Certificate Validation Enabled This property is required. bool - If certificate validation is enabled, then the call will fail in case of certification errors.
- Is
Default Snapshot Enabled This property is required. bool - If disabled, auto snapshots are not collected.
- Is
Failure Retried This property is required. bool - If isFailureRetried is enabled, then a failed call will be retried.
- Is
Query Recursive This property is required. bool - If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
- Is
Redirection Enabled This property is required. bool - If redirection is enabled, then redirects will be allowed while accessing target URL.
- Name
Server This property is required. string - Name of the server that will be used to perform DNS lookup.
- Network
Configurations This property is required. List<GetMonitors Monitor Collection Item Configuration Network Configuration> - Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
- Protocol
This property is required. string - Type of protocol.
- Query
This property is required. string - SQL query to be executed.
- Record
Type This property is required. string - DNS record type.
- Req
Authentication Details This property is required. List<GetMonitors Monitor Collection Item Configuration Req Authentication Detail> - Details for request HTTP authentication.
- Req
Authentication Scheme This property is required. string - Request HTTP authentication scheme.
- Request
Headers This property is required. List<GetMonitors Monitor Collection Item Configuration Request Header> - List of request headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- Request
Method This property is required. string - Request HTTP method.
- Request
Post Body This property is required. string - Request post body content.
- Request
Query Params This property is required. List<GetMonitors Monitor Collection Item Configuration Request Query Param> - List of request query params. Example:
[{"paramName": "sortOrder", "paramValue": "asc"}]
- Upload
File Size In Bytes This property is required. int - File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.
- Verify
Response Codes This property is required. List<string> - Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- Verify
Response Content This property is required. 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.
- Verify
Texts This property is required. 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.
- Client
Certificate Details This property is required. []GetMonitors Monitor Collection Item Configuration Client Certificate Detail - Details for client certificate.
- Config
Type This property is required. string - Type of configuration.
- Connection
String This property is required. string - Database connection string.
- Database
Authentication Details This property is required. []GetMonitors Monitor Collection Item Configuration Database Authentication Detail - Details for basic authentication.
- Database
Connection Type This property is required. string - Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type.
- Database
Role This property is required. string - Database role.
- Database
Type This property is required. string - Database type.
- Database
Wallet Details This property is required. []GetMonitors Monitor Collection Item Configuration Database Wallet Detail - Details for database wallet.
- Dns
Configurations This property is required. []GetMonitors Monitor Collection Item Configuration Dns Configuration - Information about the DNS settings.
- Download
Size Limit In Bytes This property is required. int - Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.
- Ftp
Basic Authentication Details This property is required. []GetMonitors Monitor Collection Item Configuration Ftp Basic Authentication Detail - Details for basic authentication.
- Ftp
Protocol This property is required. string - FTP protocol type.
- Ftp
Request Type This property is required. string - FTP monitor request type.
- Is
Active Mode This property is required. bool - If enabled, Active mode will be used for the FTP connection.
- Is
Certificate Validation Enabled This property is required. bool - If certificate validation is enabled, then the call will fail in case of certification errors.
- Is
Default Snapshot Enabled This property is required. bool - If disabled, auto snapshots are not collected.
- Is
Failure Retried This property is required. bool - If isFailureRetried is enabled, then a failed call will be retried.
- Is
Query Recursive This property is required. bool - If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
- Is
Redirection Enabled This property is required. bool - If redirection is enabled, then redirects will be allowed while accessing target URL.
- Name
Server This property is required. string - Name of the server that will be used to perform DNS lookup.
- Network
Configurations This property is required. []GetMonitors Monitor Collection Item Configuration Network Configuration - Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
- Protocol
This property is required. string - Type of protocol.
- Query
This property is required. string - SQL query to be executed.
- Record
Type This property is required. string - DNS record type.
- Req
Authentication Details This property is required. []GetMonitors Monitor Collection Item Configuration Req Authentication Detail - Details for request HTTP authentication.
- Req
Authentication Scheme This property is required. string - Request HTTP authentication scheme.
- Request
Headers This property is required. []GetMonitors Monitor Collection Item Configuration Request Header - List of request headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- Request
Method This property is required. string - Request HTTP method.
- Request
Post Body This property is required. string - Request post body content.
- Request
Query Params This property is required. []GetMonitors Monitor Collection Item Configuration Request Query Param - List of request query params. Example:
[{"paramName": "sortOrder", "paramValue": "asc"}]
- Upload
File Size In Bytes This property is required. int - File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.
- Verify
Response Codes This property is required. []string - Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- Verify
Response Content This property is required. 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.
- Verify
Texts This property is required. []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.
- client
Certificate Details This property is required. List<GetMonitors Monitor Collection Item Configuration Client Certificate Detail> - Details for client certificate.
- config
Type This property is required. String - Type of configuration.
- connection
String This property is required. String - Database connection string.
- database
Authentication Details This property is required. List<GetMonitors Monitor Collection Item Configuration Database Authentication Detail> - Details for basic authentication.
- database
Connection Type This property is required. String - Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type.
- database
Role This property is required. String - Database role.
- database
Type This property is required. String - Database type.
- database
Wallet Details This property is required. List<GetMonitors Monitor Collection Item Configuration Database Wallet Detail> - Details for database wallet.
- dns
Configurations This property is required. List<GetMonitors Monitor Collection Item Configuration Dns Configuration> - Information about the DNS settings.
- download
Size Limit In Bytes This property is required. Integer - Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.
- ftp
Basic Authentication Details This property is required. List<GetMonitors Monitor Collection Item Configuration Ftp Basic Authentication Detail> - Details for basic authentication.
- ftp
Protocol This property is required. String - FTP protocol type.
- ftp
Request Type This property is required. String - FTP monitor request type.
- is
Active Mode This property is required. Boolean - If enabled, Active mode will be used for the FTP connection.
- is
Certificate Validation Enabled This property is required. Boolean - If certificate validation is enabled, then the call will fail in case of certification errors.
- is
Default Snapshot Enabled This property is required. Boolean - If disabled, auto snapshots are not collected.
- is
Failure Retried This property is required. Boolean - If isFailureRetried is enabled, then a failed call will be retried.
- is
Query Recursive This property is required. Boolean - If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
- is
Redirection Enabled This property is required. Boolean - If redirection is enabled, then redirects will be allowed while accessing target URL.
- name
Server This property is required. String - Name of the server that will be used to perform DNS lookup.
- network
Configurations This property is required. List<GetMonitors Monitor Collection Item Configuration Network Configuration> - Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
- protocol
This property is required. String - Type of protocol.
- query
This property is required. String - SQL query to be executed.
- record
Type This property is required. String - DNS record type.
- req
Authentication Details This property is required. List<GetMonitors Monitor Collection Item Configuration Req Authentication Detail> - Details for request HTTP authentication.
- req
Authentication Scheme This property is required. String - Request HTTP authentication scheme.
- request
Headers This property is required. List<GetMonitors Monitor Collection Item Configuration Request Header> - List of request headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- request
Method This property is required. String - Request HTTP method.
- request
Post Body This property is required. String - Request post body content.
- request
Query Params This property is required. List<GetMonitors Monitor Collection Item Configuration Request Query Param> - List of request query params. Example:
[{"paramName": "sortOrder", "paramValue": "asc"}]
- upload
File Size In Bytes This property is required. Integer - File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.
- verify
Response Codes This property is required. List<String> - Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- verify
Response Content This property is required. 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.
- verify
Texts This property is required. 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.
- client
Certificate Details This property is required. GetMonitors Monitor Collection Item Configuration Client Certificate Detail[] - Details for client certificate.
- config
Type This property is required. string - Type of configuration.
- connection
String This property is required. string - Database connection string.
- database
Authentication Details This property is required. GetMonitors Monitor Collection Item Configuration Database Authentication Detail[] - Details for basic authentication.
- database
Connection Type This property is required. string - Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type.
- database
Role This property is required. string - Database role.
- database
Type This property is required. string - Database type.
- database
Wallet Details This property is required. GetMonitors Monitor Collection Item Configuration Database Wallet Detail[] - Details for database wallet.
- dns
Configurations This property is required. GetMonitors Monitor Collection Item Configuration Dns Configuration[] - Information about the DNS settings.
- download
Size Limit In Bytes This property is required. number - Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.
- ftp
Basic Authentication Details This property is required. GetMonitors Monitor Collection Item Configuration Ftp Basic Authentication Detail[] - Details for basic authentication.
- ftp
Protocol This property is required. string - FTP protocol type.
- ftp
Request Type This property is required. string - FTP monitor request type.
- is
Active Mode This property is required. boolean - If enabled, Active mode will be used for the FTP connection.
- is
Certificate Validation Enabled This property is required. boolean - If certificate validation is enabled, then the call will fail in case of certification errors.
- is
Default Snapshot Enabled This property is required. boolean - If disabled, auto snapshots are not collected.
- is
Failure Retried This property is required. boolean - If isFailureRetried is enabled, then a failed call will be retried.
- is
Query Recursive This property is required. boolean - If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
- is
Redirection Enabled This property is required. boolean - If redirection is enabled, then redirects will be allowed while accessing target URL.
- name
Server This property is required. string - Name of the server that will be used to perform DNS lookup.
- network
Configurations This property is required. GetMonitors Monitor Collection Item Configuration Network Configuration[] - Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
- protocol
This property is required. string - Type of protocol.
- query
This property is required. string - SQL query to be executed.
- record
Type This property is required. string - DNS record type.
- req
Authentication Details This property is required. GetMonitors Monitor Collection Item Configuration Req Authentication Detail[] - Details for request HTTP authentication.
- req
Authentication Scheme This property is required. string - Request HTTP authentication scheme.
- request
Headers This property is required. GetMonitors Monitor Collection Item Configuration Request Header[] - List of request headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- request
Method This property is required. string - Request HTTP method.
- request
Post Body This property is required. string - Request post body content.
- request
Query Params This property is required. GetMonitors Monitor Collection Item Configuration Request Query Param[] - List of request query params. Example:
[{"paramName": "sortOrder", "paramValue": "asc"}]
- upload
File Size In Bytes This property is required. number - File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.
- verify
Response Codes This property is required. string[] - Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- verify
Response Content This property is required. 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.
- verify
Texts This property is required. 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.
- client_
certificate_ details This property is required. Sequence[apmsynthetics.Get Monitors Monitor Collection Item Configuration Client Certificate Detail] - Details for client certificate.
- config_
type This property is required. str - Type of configuration.
- connection_
string This property is required. str - Database connection string.
- database_
authentication_ details This property is required. Sequence[apmsynthetics.Get Monitors Monitor Collection Item Configuration Database Authentication Detail] - Details for basic authentication.
- database_
connection_ type This property is required. str - Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type.
- database_
role This property is required. str - Database role.
- database_
type This property is required. str - Database type.
- database_
wallet_ details This property is required. Sequence[apmsynthetics.Get Monitors Monitor Collection Item Configuration Database Wallet Detail] - Details for database wallet.
- dns_
configurations This property is required. Sequence[apmsynthetics.Get Monitors Monitor Collection Item Configuration Dns Configuration] - Information about the DNS settings.
- download_
size_ limit_ in_ bytes This property is required. int - Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.
- ftp_
basic_ authentication_ details This property is required. Sequence[apmsynthetics.Get Monitors Monitor Collection Item Configuration Ftp Basic Authentication Detail] - Details for basic authentication.
- ftp_
protocol This property is required. str - FTP protocol type.
- ftp_
request_ type This property is required. str - FTP monitor request type.
- is_
active_ mode This property is required. bool - If enabled, Active mode will be used for the FTP connection.
- is_
certificate_ validation_ enabled This property is required. bool - If certificate validation is enabled, then the call will fail in case of certification errors.
- is_
default_ snapshot_ enabled This property is required. bool - If disabled, auto snapshots are not collected.
- is_
failure_ retried This property is required. bool - If isFailureRetried is enabled, then a failed call will be retried.
- is_
query_ recursive This property is required. bool - If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
- is_
redirection_ enabled This property is required. bool - If redirection is enabled, then redirects will be allowed while accessing target URL.
- name_
server This property is required. str - Name of the server that will be used to perform DNS lookup.
- network_
configurations This property is required. Sequence[apmsynthetics.Get Monitors Monitor Collection Item Configuration Network Configuration] - Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
- protocol
This property is required. str - Type of protocol.
- query
This property is required. str - SQL query to be executed.
- record_
type This property is required. str - DNS record type.
- req_
authentication_ details This property is required. Sequence[apmsynthetics.Get Monitors Monitor Collection Item Configuration Req Authentication Detail] - Details for request HTTP authentication.
- req_
authentication_ scheme This property is required. str - Request HTTP authentication scheme.
- request_
headers This property is required. Sequence[apmsynthetics.Get Monitors Monitor Collection Item Configuration Request Header] - List of request headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- request_
method This property is required. str - Request HTTP method.
- request_
post_ body This property is required. str - Request post body content.
- request_
query_ params This property is required. Sequence[apmsynthetics.Get Monitors Monitor Collection Item Configuration Request Query Param] - List of request query params. Example:
[{"paramName": "sortOrder", "paramValue": "asc"}]
- upload_
file_ size_ in_ bytes This property is required. int - File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.
- verify_
response_ codes This property is required. Sequence[str] - Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- verify_
response_ content This property is required. 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 This property is required. Sequence[apmsynthetics.Get Monitors 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.
- client
Certificate Details This property is required. List<Property Map> - Details for client certificate.
- config
Type This property is required. String - Type of configuration.
- connection
String This property is required. String - Database connection string.
- database
Authentication Details This property is required. List<Property Map> - Details for basic authentication.
- database
Connection Type This property is required. String - Database connection type. Only CUSTOM_JDBC is supported for MYSQL database type.
- database
Role This property is required. String - Database role.
- database
Type This property is required. String - Database type.
- database
Wallet Details This property is required. List<Property Map> - Details for database wallet.
- dns
Configurations This property is required. List<Property Map> - Information about the DNS settings.
- download
Size Limit In Bytes This property is required. Number - Download size limit in Bytes, at which to stop the transfer. Maximum download size limit is 5 MiB.
- ftp
Basic Authentication Details This property is required. List<Property Map> - Details for basic authentication.
- ftp
Protocol This property is required. String - FTP protocol type.
- ftp
Request Type This property is required. String - FTP monitor request type.
- is
Active Mode This property is required. Boolean - If enabled, Active mode will be used for the FTP connection.
- is
Certificate Validation Enabled This property is required. Boolean - If certificate validation is enabled, then the call will fail in case of certification errors.
- is
Default Snapshot Enabled This property is required. Boolean - If disabled, auto snapshots are not collected.
- is
Failure Retried This property is required. Boolean - If isFailureRetried is enabled, then a failed call will be retried.
- is
Query Recursive This property is required. Boolean - If isQueryRecursive is enabled, then queries will be sent recursively to the target server.
- is
Redirection Enabled This property is required. Boolean - If redirection is enabled, then redirects will be allowed while accessing target URL.
- name
Server This property is required. String - Name of the server that will be used to perform DNS lookup.
- network
Configurations This property is required. List<Property Map> - Details of the network configuration. For NETWORK monitor type, NetworkConfiguration is mandatory.
- protocol
This property is required. String - Type of protocol.
- query
This property is required. String - SQL query to be executed.
- record
Type This property is required. String - DNS record type.
- req
Authentication Details This property is required. List<Property Map> - Details for request HTTP authentication.
- req
Authentication Scheme This property is required. String - Request HTTP authentication scheme.
- request
Headers This property is required. List<Property Map> - List of request headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- request
Method This property is required. String - Request HTTP method.
- request
Post Body This property is required. String - Request post body content.
- request
Query Params This property is required. List<Property Map> - List of request query params. Example:
[{"paramName": "sortOrder", "paramValue": "asc"}]
- upload
File Size In Bytes This property is required. Number - File upload size in Bytes, at which to stop the transfer. Maximum upload size is 5 MiB.
- verify
Response Codes This property is required. List<String> - Expected HTTP response codes. For status code range, set values such as 2xx, 3xx.
- verify
Response Content This property is required. 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.
- verify
Texts This property is required. 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.
GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetail
- Client
Certificates This property is required. List<GetMonitors Monitor Collection Item Configuration Client Certificate Detail Client Certificate> - Client certificate in PEM format.
- Private
Keys This property is required. List<GetMonitors Monitor Collection Item Configuration Client Certificate Detail Private Key> - The private key associated with the client certificate in PEM format.
- Client
Certificates This property is required. []GetMonitors Monitor Collection Item Configuration Client Certificate Detail Client Certificate - Client certificate in PEM format.
- Private
Keys This property is required. []GetMonitors Monitor Collection Item Configuration Client Certificate Detail Private Key - The private key associated with the client certificate in PEM format.
- client
Certificates This property is required. List<GetMonitors Monitor Collection Item Configuration Client Certificate Detail Client Certificate> - Client certificate in PEM format.
- private
Keys This property is required. List<GetMonitors Monitor Collection Item Configuration Client Certificate Detail Private Key> - The private key associated with the client certificate in PEM format.
- client
Certificates This property is required. GetMonitors Monitor Collection Item Configuration Client Certificate Detail Client Certificate[] - Client certificate in PEM format.
- private
Keys This property is required. GetMonitors Monitor Collection Item Configuration Client Certificate Detail Private Key[] - The private key associated with the client certificate in PEM format.
- client_
certificates This property is required. Sequence[apmsynthetics.Get Monitors Monitor Collection Item Configuration Client Certificate Detail Client Certificate] - Client certificate in PEM format.
- private_
keys This property is required. Sequence[apmsynthetics.Get Monitors Monitor Collection Item Configuration Client Certificate Detail Private Key] - The private key associated with the client certificate in PEM format.
- client
Certificates This property is required. List<Property Map> - Client certificate in PEM format.
- private
Keys This property is required. List<Property Map> - The private key associated with the client certificate in PEM format.
GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetailClientCertificate
GetMonitorsMonitorCollectionItemConfigurationClientCertificateDetailPrivateKey
GetMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetail
- Passwords
This property is required. List<GetMonitors Monitor Collection Item Configuration Database Authentication Detail Password> - Password.
- Username
This property is required. string - Username for authentication.
- Passwords
This property is required. []GetMonitors Monitor Collection Item Configuration Database Authentication Detail Password - Password.
- Username
This property is required. string - Username for authentication.
- passwords
This property is required. List<GetMonitors Monitor Collection Item Configuration Database Authentication Detail Password> - Password.
- username
This property is required. String - Username for authentication.
- passwords
This property is required. GetMonitors Monitor Collection Item Configuration Database Authentication Detail Password[] - Password.
- username
This property is required. string - Username for authentication.
- passwords
This property is required. Sequence[apmsynthetics.Get Monitors Monitor Collection Item Configuration Database Authentication Detail Password] - Password.
- username
This property is required. str - Username for authentication.
- passwords
This property is required. List<Property Map> - Password.
- username
This property is required. String - Username for authentication.
GetMonitorsMonitorCollectionItemConfigurationDatabaseAuthenticationDetailPassword
- Password
This property is required. string - Password.
- Password
Type This property is required. string - Type of method to pass password.
- Vault
Secret Id This property is required. string - Vault secret OCID.
- Password
This property is required. string - Password.
- Password
Type This property is required. string - Type of method to pass password.
- Vault
Secret Id This property is required. string - Vault secret OCID.
- password
This property is required. String - Password.
- password
Type This property is required. String - Type of method to pass password.
- vault
Secret Id This property is required. String - Vault secret OCID.
- password
This property is required. string - Password.
- password
Type This property is required. string - Type of method to pass password.
- vault
Secret Id This property is required. string - Vault secret OCID.
- password
This property is required. str - Password.
- password_
type This property is required. str - Type of method to pass password.
- vault_
secret_ id This property is required. str - Vault secret OCID.
- password
This property is required. String - Password.
- password
Type This property is required. String - Type of method to pass password.
- vault
Secret Id This property is required. String - Vault secret OCID.
GetMonitorsMonitorCollectionItemConfigurationDatabaseWalletDetail
- Database
Wallet This property is required. string - The database wallet configuration zip file.
- Service
Name This property is required. string - Service name of the database.
- Database
Wallet This property is required. string - The database wallet configuration zip file.
- Service
Name This property is required. string - Service name of the database.
- database
Wallet This property is required. String - The database wallet configuration zip file.
- service
Name This property is required. String - Service name of the database.
- database
Wallet This property is required. string - The database wallet configuration zip file.
- service
Name This property is required. string - Service name of the database.
- database_
wallet This property is required. str - The database wallet configuration zip file.
- service_
name This property is required. str - Service name of the database.
- database
Wallet This property is required. String - The database wallet configuration zip file.
- service
Name This property is required. String - Service name of the database.
GetMonitorsMonitorCollectionItemConfigurationDnsConfiguration
- Is
Override Dns This property is required. bool - If isOverrideDns is true, then DNS settings will be overridden.
- Override
Dns Ip This property is required. string - Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
- Is
Override Dns This property is required. bool - If isOverrideDns is true, then DNS settings will be overridden.
- Override
Dns Ip This property is required. string - Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
- is
Override Dns This property is required. Boolean - If isOverrideDns is true, then DNS settings will be overridden.
- override
Dns Ip This property is required. String - Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
- is
Override Dns This property is required. boolean - If isOverrideDns is true, then DNS settings will be overridden.
- override
Dns Ip This property is required. string - Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
- is_
override_ dns This property is required. bool - If isOverrideDns is true, then DNS settings will be overridden.
- override_
dns_ ip This property is required. str - Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
- is
Override Dns This property is required. Boolean - If isOverrideDns is true, then DNS settings will be overridden.
- override
Dns Ip This property is required. String - Attribute to override the DNS IP value. This value will be honored only if isOverrideDns is set to true.
GetMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetail
- Passwords
This property is required. List<GetMonitors Monitor Collection Item Configuration Ftp Basic Authentication Detail Password> - Password.
- Username
This property is required. string - Username for authentication.
- Passwords
This property is required. []GetMonitors Monitor Collection Item Configuration Ftp Basic Authentication Detail Password - Password.
- Username
This property is required. string - Username for authentication.
- passwords
This property is required. List<GetMonitors Monitor Collection Item Configuration Ftp Basic Authentication Detail Password> - Password.
- username
This property is required. String - Username for authentication.
- passwords
This property is required. GetMonitors Monitor Collection Item Configuration Ftp Basic Authentication Detail Password[] - Password.
- username
This property is required. string - Username for authentication.
- passwords
This property is required. Sequence[apmsynthetics.Get Monitors Monitor Collection Item Configuration Ftp Basic Authentication Detail Password] - Password.
- username
This property is required. str - Username for authentication.
- passwords
This property is required. List<Property Map> - Password.
- username
This property is required. String - Username for authentication.
GetMonitorsMonitorCollectionItemConfigurationFtpBasicAuthenticationDetailPassword
- Password
This property is required. string - Password.
- Password
Type This property is required. string - Type of method to pass password.
- Vault
Secret Id This property is required. string - Vault secret OCID.
- Password
This property is required. string - Password.
- Password
Type This property is required. string - Type of method to pass password.
- Vault
Secret Id This property is required. string - Vault secret OCID.
- password
This property is required. String - Password.
- password
Type This property is required. String - Type of method to pass password.
- vault
Secret Id This property is required. String - Vault secret OCID.
- password
This property is required. string - Password.
- password
Type This property is required. string - Type of method to pass password.
- vault
Secret Id This property is required. string - Vault secret OCID.
- password
This property is required. str - Password.
- password_
type This property is required. str - Type of method to pass password.
- vault_
secret_ id This property is required. str - Vault secret OCID.
- password
This property is required. String - Password.
- password
Type This property is required. String - Type of method to pass password.
- vault
Secret Id This property is required. String - Vault secret OCID.
GetMonitorsMonitorCollectionItemConfigurationNetworkConfiguration
- Number
Of Hops This property is required. int - Number of hops.
- Probe
Mode This property is required. string - Type of probe mode when TCP protocol is selected.
- Probe
Per Hop This property is required. int - Number of probes per hop.
- Protocol
This property is required. string - Type of protocol.
- Transmission
Rate This property is required. int - Number of probe packets sent out simultaneously.
- Number
Of Hops This property is required. int - Number of hops.
- Probe
Mode This property is required. string - Type of probe mode when TCP protocol is selected.
- Probe
Per Hop This property is required. int - Number of probes per hop.
- Protocol
This property is required. string - Type of protocol.
- Transmission
Rate This property is required. int - Number of probe packets sent out simultaneously.
- number
Of Hops This property is required. Integer - Number of hops.
- probe
Mode This property is required. String - Type of probe mode when TCP protocol is selected.
- probe
Per Hop This property is required. Integer - Number of probes per hop.
- protocol
This property is required. String - Type of protocol.
- transmission
Rate This property is required. Integer - Number of probe packets sent out simultaneously.
- number
Of Hops This property is required. number - Number of hops.
- probe
Mode This property is required. string - Type of probe mode when TCP protocol is selected.
- probe
Per Hop This property is required. number - Number of probes per hop.
- protocol
This property is required. string - Type of protocol.
- transmission
Rate This property is required. number - Number of probe packets sent out simultaneously.
- number_
of_ hops This property is required. int - Number of hops.
- probe_
mode This property is required. str - Type of probe mode when TCP protocol is selected.
- probe_
per_ hop This property is required. int - Number of probes per hop.
- protocol
This property is required. str - Type of protocol.
- transmission_
rate This property is required. int - Number of probe packets sent out simultaneously.
- number
Of Hops This property is required. Number - Number of hops.
- probe
Mode This property is required. String - Type of probe mode when TCP protocol is selected.
- probe
Per Hop This property is required. Number - Number of probes per hop.
- protocol
This property is required. String - Type of protocol.
- transmission
Rate This property is required. Number - Number of probe packets sent out simultaneously.
GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetail
- Auth
Headers This property is required. List<GetMonitors Monitor Collection Item Configuration Req Authentication Detail Auth Header> - List of authentication headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- Auth
Request Method This property is required. string - Request method.
- Auth
Request Post Body This property is required. string - Request post body.
- Auth
Token This property is required. string - Authentication token.
- Auth
Url This property is required. string - URL to get authentication token.
- Auth
User Name This property is required. string - User name for authentication.
- Auth
User Password This property is required. string - User password for authentication.
- Oauth
Scheme This property is required. string - Request HTTP OAuth scheme.
- Auth
Headers This property is required. []GetMonitors Monitor Collection Item Configuration Req Authentication Detail Auth Header - List of authentication headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- Auth
Request Method This property is required. string - Request method.
- Auth
Request Post Body This property is required. string - Request post body.
- Auth
Token This property is required. string - Authentication token.
- Auth
Url This property is required. string - URL to get authentication token.
- Auth
User Name This property is required. string - User name for authentication.
- Auth
User Password This property is required. string - User password for authentication.
- Oauth
Scheme This property is required. string - Request HTTP OAuth scheme.
- auth
Headers This property is required. List<GetMonitors Monitor Collection Item Configuration Req Authentication Detail Auth Header> - List of authentication headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- auth
Request Method This property is required. String - Request method.
- auth
Request Post Body This property is required. String - Request post body.
- auth
Token This property is required. String - Authentication token.
- auth
Url This property is required. String - URL to get authentication token.
- auth
User Name This property is required. String - User name for authentication.
- auth
User Password This property is required. String - User password for authentication.
- oauth
Scheme This property is required. String - Request HTTP OAuth scheme.
- auth
Headers This property is required. GetMonitors Monitor Collection Item Configuration Req Authentication Detail Auth Header[] - List of authentication headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- auth
Request Method This property is required. string - Request method.
- auth
Request Post Body This property is required. string - Request post body.
- auth
Token This property is required. string - Authentication token.
- auth
Url This property is required. string - URL to get authentication token.
- auth
User Name This property is required. string - User name for authentication.
- auth
User Password This property is required. string - User password for authentication.
- oauth
Scheme This property is required. string - Request HTTP OAuth scheme.
- auth_
headers This property is required. Sequence[apmsynthetics.Get Monitors Monitor Collection Item Configuration Req Authentication Detail Auth Header] - List of authentication headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- auth_
request_ method This property is required. str - Request method.
- auth_
request_ post_ body This property is required. str - Request post body.
- auth_
token This property is required. str - Authentication token.
- auth_
url This property is required. str - URL to get authentication token.
- auth_
user_ name This property is required. str - User name for authentication.
- auth_
user_ password This property is required. str - User password for authentication.
- oauth_
scheme This property is required. str - Request HTTP OAuth scheme.
- auth
Headers This property is required. List<Property Map> - List of authentication headers. Example:
[{"headerName": "content-type", "headerValue":"json"}]
- auth
Request Method This property is required. String - Request method.
- auth
Request Post Body This property is required. String - Request post body.
- auth
Token This property is required. String - Authentication token.
- auth
Url This property is required. String - URL to get authentication token.
- auth
User Name This property is required. String - User name for authentication.
- auth
User Password This property is required. String - User password for authentication.
- oauth
Scheme This property is required. String - Request HTTP OAuth scheme.
GetMonitorsMonitorCollectionItemConfigurationReqAuthenticationDetailAuthHeader
- Header
Name This property is required. string - Name of the header.
- Header
Value This property is required. string - Value of the header.
- Header
Name This property is required. string - Name of the header.
- Header
Value This property is required. string - Value of the header.
- header
Name This property is required. String - Name of the header.
- header
Value This property is required. String - Value of the header.
- header
Name This property is required. string - Name of the header.
- header
Value This property is required. string - Value of the header.
- header_
name This property is required. str - Name of the header.
- header_
value This property is required. str - Value of the header.
- header
Name This property is required. String - Name of the header.
- header
Value This property is required. String - Value of the header.
GetMonitorsMonitorCollectionItemConfigurationRequestHeader
- Header
Name This property is required. string - Name of the header.
- Header
Value This property is required. string - Value of the header.
- Header
Name This property is required. string - Name of the header.
- Header
Value This property is required. string - Value of the header.
- header
Name This property is required. String - Name of the header.
- header
Value This property is required. String - Value of the header.
- header
Name This property is required. string - Name of the header.
- header
Value This property is required. string - Value of the header.
- header_
name This property is required. str - Name of the header.
- header_
value This property is required. str - Value of the header.
- header
Name This property is required. String - Name of the header.
- header
Value This property is required. String - Value of the header.
GetMonitorsMonitorCollectionItemConfigurationRequestQueryParam
- Param
Name This property is required. string - Name of the parameter.
- Param
Value This property is required. string - Value of the parameter.
- Param
Name This property is required. string - Name of the parameter.
- Param
Value This property is required. string - Value of the parameter.
- param
Name This property is required. String - Name of the parameter.
- param
Value This property is required. String - Value of the parameter.
- param
Name This property is required. string - Name of the parameter.
- param
Value This property is required. string - Value of the parameter.
- param_
name This property is required. str - Name of the parameter.
- param_
value This property is required. str - Value of the parameter.
- param
Name This property is required. String - Name of the parameter.
- param
Value This property is required. String - Value of the parameter.
GetMonitorsMonitorCollectionItemConfigurationVerifyText
- Text
This property is required. string - Verification text in the response.
- Text
This property is required. string - Verification text in the response.
- text
This property is required. String - Verification text in the response.
- text
This property is required. string - Verification text in the response.
- text
This property is required. str - Verification text in the response.
- text
This property is required. String - Verification text in the response.
GetMonitorsMonitorCollectionItemMaintenanceWindowSchedule
- Time
Ended This property is required. string - End time of the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- Time
Started This property is required. string - Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- Time
Ended This property is required. string - End time of the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- Time
Started This property is required. string - Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Ended This property is required. String - End time of the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Started This property is required. String - Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Ended This property is required. string - End time of the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Started This property is required. string - Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time_
ended This property is required. str - End time of the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time_
started This property is required. str - Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Ended This property is required. String - End time of the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
- time
Started This property is required. String - Start time of the maintenance window, expressed in RFC 3339 timestamp format. Example:
2020-02-12T22:47:12.613Z
GetMonitorsMonitorCollectionItemScriptParameter
- Is
Overwritten This property is required. bool - If parameter value is default or overwritten.
- Is
Secret This property is required. 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 This property is required. List<GetMonitors 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 This property is required. string - Name of the parameter.
- Param
Value This property is required. string - Value of the parameter.
- Is
Overwritten This property is required. bool - If parameter value is default or overwritten.
- Is
Secret This property is required. 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 This property is required. []GetMonitors 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 This property is required. string - Name of the parameter.
- Param
Value This property is required. string - Value of the parameter.
- is
Overwritten This property is required. Boolean - If parameter value is default or overwritten.
- is
Secret This property is required. Boolean - Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
- monitor
Script Parameters This property is required. List<GetMonitors 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 This property is required. String - Name of the parameter.
- param
Value This property is required. String - Value of the parameter.
- is
Overwritten This property is required. boolean - If parameter value is default or overwritten.
- is
Secret This property is required. boolean - Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
- monitor
Script Parameters This property is required. GetMonitors 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 This property is required. string - Name of the parameter.
- param
Value This property is required. string - Value of the parameter.
- is_
overwritten This property is required. bool - If parameter value is default or overwritten.
- is_
secret This property is required. 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 This property is required. Sequence[apmsynthetics.Get 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 This property is required. str - Name of the parameter.
- param_
value This property is required. str - Value of the parameter.
- is
Overwritten This property is required. Boolean - If parameter value is default or overwritten.
- is
Secret This property is required. Boolean - Describes if the parameter value is secret and should be kept confidential. isSecret is specified in either CreateScript or UpdateScript API.
- monitor
Script Parameters This property is required. List<Property Map> - Details of the script parameter that can be used to overwrite the parameter present in the script.
- param
Name This property is required. String - Name of the parameter.
- param
Value This property is required. String - Value of the parameter.
GetMonitorsMonitorCollectionItemScriptParameterMonitorScriptParameter
- Param
Name This property is required. string - Name of the parameter.
- Param
Value This property is required. string - Value of the parameter.
- Param
Name This property is required. string - Name of the parameter.
- Param
Value This property is required. string - Value of the parameter.
- param
Name This property is required. String - Name of the parameter.
- param
Value This property is required. String - Value of the parameter.
- param
Name This property is required. string - Name of the parameter.
- param
Value This property is required. string - Value of the parameter.
- param_
name This property is required. str - Name of the parameter.
- param_
value This property is required. str - Value of the parameter.
- param
Name This property is required. String - Name of the parameter.
- param
Value This property is required. String - Value of the parameter.
GetMonitorsMonitorCollectionItemVantagePoint
- Display
Name This property is required. string - A filter to return only the resources that match the entire display name.
- Name
This property is required. string - Name of the vantage point.
- Worker
Lists This property is required. List<string> - List of workers running the assigned monitor.
- Display
Name This property is required. string - A filter to return only the resources that match the entire display name.
- Name
This property is required. string - Name of the vantage point.
- Worker
Lists This property is required. []string - List of workers running the assigned monitor.
- display
Name This property is required. String - A filter to return only the resources that match the entire display name.
- name
This property is required. String - Name of the vantage point.
- worker
Lists This property is required. List<String> - List of workers running the assigned monitor.
- display
Name This property is required. string - A filter to return only the resources that match the entire display name.
- name
This property is required. string - Name of the vantage point.
- worker
Lists This property is required. string[] - List of workers running the assigned monitor.
- display_
name This property is required. str - A filter to return only the resources that match the entire display name.
- name
This property is required. str - Name of the vantage point.
- worker_
lists This property is required. Sequence[str] - List of workers running the assigned monitor.
- display
Name This property is required. String - A filter to return only the resources that match the entire display name.
- name
This property is required. String - Name of the vantage point.
- worker
Lists This property is required. List<String> - List of workers running the assigned monitor.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.