Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi
oci.ApmSynthetics.getOnPremiseVantagePointWorker
Explore with Pulumi AI
This data source provides details about a specific On Premise Vantage Point Worker resource in Oracle Cloud Infrastructure APM Availability Monitoring service (aka APM Synthetics Service).
Gets the details of the worker identified by the OCID.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testOnPremiseVantagePointWorker = oci.ApmSynthetics.getOnPremiseVantagePointWorker({
    apmDomainId: testApmDomain.id,
    onPremiseVantagePointId: testOnPremiseVantagePoint.id,
    workerId: testWorker.id,
});
import pulumi
import pulumi_oci as oci
test_on_premise_vantage_point_worker = oci.ApmSynthetics.get_on_premise_vantage_point_worker(apm_domain_id=test_apm_domain["id"],
    on_premise_vantage_point_id=test_on_premise_vantage_point["id"],
    worker_id=test_worker["id"])
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.GetOnPremiseVantagePointWorker(ctx, &apmsynthetics.GetOnPremiseVantagePointWorkerArgs{
			ApmDomainId:             testApmDomain.Id,
			OnPremiseVantagePointId: testOnPremiseVantagePoint.Id,
			WorkerId:                testWorker.Id,
		}, 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 testOnPremiseVantagePointWorker = Oci.ApmSynthetics.GetOnPremiseVantagePointWorker.Invoke(new()
    {
        ApmDomainId = testApmDomain.Id,
        OnPremiseVantagePointId = testOnPremiseVantagePoint.Id,
        WorkerId = testWorker.Id,
    });
});
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.GetOnPremiseVantagePointWorkerArgs;
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 testOnPremiseVantagePointWorker = ApmSyntheticsFunctions.getOnPremiseVantagePointWorker(GetOnPremiseVantagePointWorkerArgs.builder()
            .apmDomainId(testApmDomain.id())
            .onPremiseVantagePointId(testOnPremiseVantagePoint.id())
            .workerId(testWorker.id())
            .build());
    }
}
variables:
  testOnPremiseVantagePointWorker:
    fn::invoke:
      function: oci:ApmSynthetics:getOnPremiseVantagePointWorker
      arguments:
        apmDomainId: ${testApmDomain.id}
        onPremiseVantagePointId: ${testOnPremiseVantagePoint.id}
        workerId: ${testWorker.id}
Using getOnPremiseVantagePointWorker
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 getOnPremiseVantagePointWorker(args: GetOnPremiseVantagePointWorkerArgs, opts?: InvokeOptions): Promise<GetOnPremiseVantagePointWorkerResult>
function getOnPremiseVantagePointWorkerOutput(args: GetOnPremiseVantagePointWorkerOutputArgs, opts?: InvokeOptions): Output<GetOnPremiseVantagePointWorkerResult>def get_on_premise_vantage_point_worker(apm_domain_id: Optional[str] = None,
                                        on_premise_vantage_point_id: Optional[str] = None,
                                        worker_id: Optional[str] = None,
                                        opts: Optional[InvokeOptions] = None) -> GetOnPremiseVantagePointWorkerResult
def get_on_premise_vantage_point_worker_output(apm_domain_id: Optional[pulumi.Input[str]] = None,
                                        on_premise_vantage_point_id: Optional[pulumi.Input[str]] = None,
                                        worker_id: Optional[pulumi.Input[str]] = None,
                                        opts: Optional[InvokeOptions] = None) -> Output[GetOnPremiseVantagePointWorkerResult]func GetOnPremiseVantagePointWorker(ctx *Context, args *GetOnPremiseVantagePointWorkerArgs, opts ...InvokeOption) (*GetOnPremiseVantagePointWorkerResult, error)
func GetOnPremiseVantagePointWorkerOutput(ctx *Context, args *GetOnPremiseVantagePointWorkerOutputArgs, opts ...InvokeOption) GetOnPremiseVantagePointWorkerResultOutput> Note: This function is named GetOnPremiseVantagePointWorker in the Go SDK.
public static class GetOnPremiseVantagePointWorker 
{
    public static Task<GetOnPremiseVantagePointWorkerResult> InvokeAsync(GetOnPremiseVantagePointWorkerArgs args, InvokeOptions? opts = null)
    public static Output<GetOnPremiseVantagePointWorkerResult> Invoke(GetOnPremiseVantagePointWorkerInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetOnPremiseVantagePointWorkerResult> getOnPremiseVantagePointWorker(GetOnPremiseVantagePointWorkerArgs args, InvokeOptions options)
public static Output<GetOnPremiseVantagePointWorkerResult> getOnPremiseVantagePointWorker(GetOnPremiseVantagePointWorkerArgs args, InvokeOptions options)
fn::invoke:
  function: oci:ApmSynthetics/getOnPremiseVantagePointWorker:getOnPremiseVantagePointWorker
  arguments:
    # arguments dictionaryThe following arguments are supported:
- ApmDomain stringId 
- The APM domain ID the request is intended for.
- OnPremise stringVantage Point Id 
- The OCID of the On-premise vantage point.
- WorkerId string
- The OCID of the On-premise vantage point worker.
- ApmDomain stringId 
- The APM domain ID the request is intended for.
- OnPremise stringVantage Point Id 
- The OCID of the On-premise vantage point.
- WorkerId string
- The OCID of the On-premise vantage point worker.
- apmDomain StringId 
- The APM domain ID the request is intended for.
- onPremise StringVantage Point Id 
- The OCID of the On-premise vantage point.
- workerId String
- The OCID of the On-premise vantage point worker.
- apmDomain stringId 
- The APM domain ID the request is intended for.
- onPremise stringVantage Point Id 
- The OCID of the On-premise vantage point.
- workerId string
- The OCID of the On-premise vantage point worker.
- apm_domain_ strid 
- The APM domain ID the request is intended for.
- on_premise_ strvantage_ point_ id 
- The OCID of the On-premise vantage point.
- worker_id str
- The OCID of the On-premise vantage point worker.
- apmDomain StringId 
- The APM domain ID the request is intended for.
- onPremise StringVantage Point Id 
- The OCID of the On-premise vantage point.
- workerId String
- The OCID of the On-premise vantage point worker.
getOnPremiseVantagePointWorker Result
The following output properties are available:
- ApmDomain stringId 
- ConfigurationDetails string
- Configuration details of the On-premise VP worker.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- DisplayName string
- Unique name that can be edited. The name should not contain any confidential information.
- 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"}
- GeoInfo string
- Geographical information of the On-premise VP worker.
- Id string
- The OCID of the monitor.
- IdentityInfos List<GetOn Premise Vantage Point Worker Identity Info> 
- Domain details of the On-premise VP worker.
- MonitorLists List<GetOn Premise Vantage Point Worker Monitor List> 
- Monitors list assigned to the On-premise VP worker.
- Name string
- Unique permanent name of the On-premise VP worker. This is the same as the displayName.
- OnPremise stringVantage Point Id 
- OpvpId string
- The OCID of the On-premise vantage point.
- OpvpName string
- On-premise vantage point name.
- Priority int
- Priority of the On-premise VP worker to schedule monitors.
- ResourcePrincipal stringToken Public Key 
- RuntimeId string
- The runtime assigned id of the On-premise VP worker.
- Status string
- Enables or disables the On-premise VP worker.
- TimeCreated string
- The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- TimeLast stringSync Up 
- The time the resource was last synced, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- TimeUpdated string
- The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
- Version string
- Current image version of the On-premise VP worker.
- VersionDetails List<GetOn Premise Vantage Point Worker Version Detail> 
- Image version details of the On-premise VP worker.
- WorkerId string
- WorkerType string
- Type of the On-premise VP worker.
- ApmDomain stringId 
- ConfigurationDetails string
- Configuration details of the On-premise VP worker.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- DisplayName string
- Unique name that can be edited. The name should not contain any confidential information.
- 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"}
- GeoInfo string
- Geographical information of the On-premise VP worker.
- Id string
- The OCID of the monitor.
- IdentityInfos []GetOn Premise Vantage Point Worker Identity Info 
- Domain details of the On-premise VP worker.
- MonitorLists []GetOn Premise Vantage Point Worker Monitor List 
- Monitors list assigned to the On-premise VP worker.
- Name string
- Unique permanent name of the On-premise VP worker. This is the same as the displayName.
- OnPremise stringVantage Point Id 
- OpvpId string
- The OCID of the On-premise vantage point.
- OpvpName string
- On-premise vantage point name.
- Priority int
- Priority of the On-premise VP worker to schedule monitors.
- ResourcePrincipal stringToken Public Key 
- RuntimeId string
- The runtime assigned id of the On-premise VP worker.
- Status string
- Enables or disables the On-premise VP worker.
- TimeCreated string
- The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- TimeLast stringSync Up 
- The time the resource was last synced, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- TimeUpdated string
- The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
- Version string
- Current image version of the On-premise VP worker.
- VersionDetails []GetOn Premise Vantage Point Worker Version Detail 
- Image version details of the On-premise VP worker.
- WorkerId string
- WorkerType string
- Type of the On-premise VP worker.
- apmDomain StringId 
- configurationDetails String
- Configuration details of the On-premise VP worker.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- displayName String
- Unique name that can be edited. The name should not contain any confidential information.
- 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"}
- geoInfo String
- Geographical information of the On-premise VP worker.
- id String
- The OCID of the monitor.
- identityInfos List<GetOn Premise Vantage Point Worker Identity Info> 
- Domain details of the On-premise VP worker.
- monitorLists List<GetOn Premise Vantage Point Worker Monitor List> 
- Monitors list assigned to the On-premise VP worker.
- name String
- Unique permanent name of the On-premise VP worker. This is the same as the displayName.
- onPremise StringVantage Point Id 
- opvpId String
- The OCID of the On-premise vantage point.
- opvpName String
- On-premise vantage point name.
- priority Integer
- Priority of the On-premise VP worker to schedule monitors.
- resourcePrincipal StringToken Public Key 
- runtimeId String
- The runtime assigned id of the On-premise VP worker.
- status String
- Enables or disables the On-premise VP worker.
- timeCreated String
- The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- timeLast StringSync Up 
- The time the resource was last synced, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- timeUpdated String
- The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
- version String
- Current image version of the On-premise VP worker.
- versionDetails List<GetOn Premise Vantage Point Worker Version Detail> 
- Image version details of the On-premise VP worker.
- workerId String
- workerType String
- Type of the On-premise VP worker.
- apmDomain stringId 
- configurationDetails string
- Configuration details of the On-premise VP worker.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- displayName string
- Unique name that can be edited. The name should not contain any confidential information.
- {[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"}
- geoInfo string
- Geographical information of the On-premise VP worker.
- id string
- The OCID of the monitor.
- identityInfos GetOn Premise Vantage Point Worker Identity Info[] 
- Domain details of the On-premise VP worker.
- monitorLists GetOn Premise Vantage Point Worker Monitor List[] 
- Monitors list assigned to the On-premise VP worker.
- name string
- Unique permanent name of the On-premise VP worker. This is the same as the displayName.
- onPremise stringVantage Point Id 
- opvpId string
- The OCID of the On-premise vantage point.
- opvpName string
- On-premise vantage point name.
- priority number
- Priority of the On-premise VP worker to schedule monitors.
- resourcePrincipal stringToken Public Key 
- runtimeId string
- The runtime assigned id of the On-premise VP worker.
- status string
- Enables or disables the On-premise VP worker.
- timeCreated string
- The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- timeLast stringSync Up 
- The time the resource was last synced, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- timeUpdated string
- The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
- version string
- Current image version of the On-premise VP worker.
- versionDetails GetOn Premise Vantage Point Worker Version Detail[] 
- Image version details of the On-premise VP worker.
- workerId string
- workerType string
- Type of the On-premise VP worker.
- apm_domain_ strid 
- configuration_details str
- Configuration details of the On-premise VP worker.
- 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 str
- Unique name that can be edited. The name should not contain any confidential information.
- 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"}
- geo_info str
- Geographical information of the On-premise VP worker.
- id str
- The OCID of the monitor.
- identity_infos Sequence[apmsynthetics.Get On Premise Vantage Point Worker Identity Info] 
- Domain details of the On-premise VP worker.
- monitor_lists Sequence[apmsynthetics.Get On Premise Vantage Point Worker Monitor List] 
- Monitors list assigned to the On-premise VP worker.
- name str
- Unique permanent name of the On-premise VP worker. This is the same as the displayName.
- on_premise_ strvantage_ point_ id 
- opvp_id str
- The OCID of the On-premise vantage point.
- opvp_name str
- On-premise vantage point name.
- priority int
- Priority of the On-premise VP worker to schedule monitors.
- resource_principal_ strtoken_ public_ key 
- runtime_id str
- The runtime assigned id of the On-premise VP worker.
- status str
- Enables or disables the On-premise VP worker.
- time_created str
- The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- time_last_ strsync_ up 
- The time the resource was last synced, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- time_updated str
- The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
- version str
- Current image version of the On-premise VP worker.
- version_details Sequence[apmsynthetics.Get On Premise Vantage Point Worker Version Detail] 
- Image version details of the On-premise VP worker.
- worker_id str
- worker_type str
- Type of the On-premise VP worker.
- apmDomain StringId 
- configurationDetails String
- Configuration details of the On-premise VP worker.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
- displayName String
- Unique name that can be edited. The name should not contain any confidential information.
- 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"}
- geoInfo String
- Geographical information of the On-premise VP worker.
- id String
- The OCID of the monitor.
- identityInfos List<Property Map>
- Domain details of the On-premise VP worker.
- monitorLists List<Property Map>
- Monitors list assigned to the On-premise VP worker.
- name String
- Unique permanent name of the On-premise VP worker. This is the same as the displayName.
- onPremise StringVantage Point Id 
- opvpId String
- The OCID of the On-premise vantage point.
- opvpName String
- On-premise vantage point name.
- priority Number
- Priority of the On-premise VP worker to schedule monitors.
- resourcePrincipal StringToken Public Key 
- runtimeId String
- The runtime assigned id of the On-premise VP worker.
- status String
- Enables or disables the On-premise VP worker.
- timeCreated String
- The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- timeLast StringSync Up 
- The time the resource was last synced, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- timeUpdated String
- The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
- version String
- Current image version of the On-premise VP worker.
- versionDetails List<Property Map>
- Image version details of the On-premise VP worker.
- workerId String
- workerType String
- Type of the On-premise VP worker.
Supporting Types
GetOnPremiseVantagePointWorkerIdentityInfo       
- ApmShort stringId 
- Domain short id of the On-premise VP worker.
- CollectorEnd stringPoint 
- Collector endpoint of the On-premise VP worker.
- RegionName string
- Domain region of the On-premise VP worker.
- ApmShort stringId 
- Domain short id of the On-premise VP worker.
- CollectorEnd stringPoint 
- Collector endpoint of the On-premise VP worker.
- RegionName string
- Domain region of the On-premise VP worker.
- apmShort StringId 
- Domain short id of the On-premise VP worker.
- collectorEnd StringPoint 
- Collector endpoint of the On-premise VP worker.
- regionName String
- Domain region of the On-premise VP worker.
- apmShort stringId 
- Domain short id of the On-premise VP worker.
- collectorEnd stringPoint 
- Collector endpoint of the On-premise VP worker.
- regionName string
- Domain region of the On-premise VP worker.
- apm_short_ strid 
- Domain short id of the On-premise VP worker.
- collector_end_ strpoint 
- Collector endpoint of the On-premise VP worker.
- region_name str
- Domain region of the On-premise VP worker.
- apmShort StringId 
- Domain short id of the On-premise VP worker.
- collectorEnd StringPoint 
- Collector endpoint of the On-premise VP worker.
- regionName String
- Domain region of the On-premise VP worker.
GetOnPremiseVantagePointWorkerMonitorList       
- DisplayName string
- Unique name that can be edited. The name should not contain any confidential information.
- Id string
- The OCID of the monitor.
- IsRun boolNow 
- If isRunNow is enabled, then the monitor will run immediately.
- MonitorType string
- Type of monitor.
- TimeAssigned string
- The time the resource was last assigned to an On-premise vantage point worker, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- DisplayName string
- Unique name that can be edited. The name should not contain any confidential information.
- Id string
- The OCID of the monitor.
- IsRun boolNow 
- If isRunNow is enabled, then the monitor will run immediately.
- MonitorType string
- Type of monitor.
- TimeAssigned string
- The time the resource was last assigned to an On-premise vantage point worker, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- displayName String
- Unique name that can be edited. The name should not contain any confidential information.
- id String
- The OCID of the monitor.
- isRun BooleanNow 
- If isRunNow is enabled, then the monitor will run immediately.
- monitorType String
- Type of monitor.
- timeAssigned String
- The time the resource was last assigned to an On-premise vantage point worker, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- displayName string
- Unique name that can be edited. The name should not contain any confidential information.
- id string
- The OCID of the monitor.
- isRun booleanNow 
- If isRunNow is enabled, then the monitor will run immediately.
- monitorType string
- Type of monitor.
- timeAssigned string
- The time the resource was last assigned to an On-premise vantage point worker, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- display_name str
- Unique name that can be edited. The name should not contain any confidential information.
- id str
- The OCID of the monitor.
- is_run_ boolnow 
- If isRunNow is enabled, then the monitor will run immediately.
- monitor_type str
- Type of monitor.
- time_assigned str
- The time the resource was last assigned to an On-premise vantage point worker, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
- displayName String
- Unique name that can be edited. The name should not contain any confidential information.
- id String
- The OCID of the monitor.
- isRun BooleanNow 
- If isRunNow is enabled, then the monitor will run immediately.
- monitorType String
- Type of monitor.
- timeAssigned String
- The time the resource was last assigned to an On-premise vantage point worker, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
GetOnPremiseVantagePointWorkerVersionDetail       
- LatestVersion string
- Latest image version of the On-premise VP worker.
- MinSupported stringVersion 
- Minimum supported image version of the On-premise VP worker.
- Version string
- Current image version of the On-premise VP worker.
- LatestVersion string
- Latest image version of the On-premise VP worker.
- MinSupported stringVersion 
- Minimum supported image version of the On-premise VP worker.
- Version string
- Current image version of the On-premise VP worker.
- latestVersion String
- Latest image version of the On-premise VP worker.
- minSupported StringVersion 
- Minimum supported image version of the On-premise VP worker.
- version String
- Current image version of the On-premise VP worker.
- latestVersion string
- Latest image version of the On-premise VP worker.
- minSupported stringVersion 
- Minimum supported image version of the On-premise VP worker.
- version string
- Current image version of the On-premise VP worker.
- latest_version str
- Latest image version of the On-premise VP worker.
- min_supported_ strversion 
- Minimum supported image version of the On-premise VP worker.
- version str
- Current image version of the On-premise VP worker.
- latestVersion String
- Latest image version of the On-premise VP worker.
- minSupported StringVersion 
- Minimum supported image version of the On-premise VP worker.
- version String
- Current image version of the On-premise VP worker.
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the ociTerraform Provider.