Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ApmSynthetics
  5. getOnPremiseVantagePoint
Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-oci

oci.ApmSynthetics.getOnPremiseVantagePoint

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific On Premise Vantage Point resource in Oracle Cloud Infrastructure APM Availability Monitoring service (aka APM Synthetics Service).

    Gets the details of the On-premise vantage point identified by the OCID.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testOnPremiseVantagePoint = oci.ApmSynthetics.getOnPremiseVantagePoint({
    apmDomainId: testApmDomain.id,
    onPremiseVantagePointId: testOnPremiseVantagePointOciApmSyntheticsOnPremiseVantagePoint.id,
});

    import pulumi
import pulumi_oci as oci

test_on_premise_vantage_point = oci.ApmSynthetics.get_on_premise_vantage_point(apm_domain_id=test_apm_domain["id"],
    on_premise_vantage_point_id=test_on_premise_vantage_point_oci_apm_synthetics_on_premise_vantage_point["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.GetOnPremiseVantagePoint(ctx, &apmsynthetics.GetOnPremiseVantagePointArgs{
			ApmDomainId:             testApmDomain.Id,
			OnPremiseVantagePointId: testOnPremiseVantagePointOciApmSyntheticsOnPremiseVantagePoint.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 testOnPremiseVantagePoint = Oci.ApmSynthetics.GetOnPremiseVantagePoint.Invoke(new()
    {
        ApmDomainId = testApmDomain.Id,
        OnPremiseVantagePointId = testOnPremiseVantagePointOciApmSyntheticsOnPremiseVantagePoint.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.GetOnPremiseVantagePointArgs;
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 testOnPremiseVantagePoint = ApmSyntheticsFunctions.getOnPremiseVantagePoint(GetOnPremiseVantagePointArgs.builder()
            .apmDomainId(testApmDomain.id())
            .onPremiseVantagePointId(testOnPremiseVantagePointOciApmSyntheticsOnPremiseVantagePoint.id())
            .build());

    }
}

    variables:
  testOnPremiseVantagePoint:
    fn::invoke:
      function: oci:ApmSynthetics:getOnPremiseVantagePoint
      arguments:
        apmDomainId: ${testApmDomain.id}
        onPremiseVantagePointId: ${testOnPremiseVantagePointOciApmSyntheticsOnPremiseVantagePoint.id}

    Using getOnPremiseVantagePoint

    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 getOnPremiseVantagePoint(args: GetOnPremiseVantagePointArgs, opts?: InvokeOptions): Promise<GetOnPremiseVantagePointResult>
function getOnPremiseVantagePointOutput(args: GetOnPremiseVantagePointOutputArgs, opts?: InvokeOptions): Output<GetOnPremiseVantagePointResult>
    def get_on_premise_vantage_point(apm_domain_id: Optional[str] = None,
                                 on_premise_vantage_point_id: Optional[str] = None,
                                 opts: Optional[InvokeOptions] = None) -> GetOnPremiseVantagePointResult
def get_on_premise_vantage_point_output(apm_domain_id: Optional[pulumi.Input[str]] = None,
                                 on_premise_vantage_point_id: Optional[pulumi.Input[str]] = None,
                                 opts: Optional[InvokeOptions] = None) -> Output[GetOnPremiseVantagePointResult]
    func GetOnPremiseVantagePoint(ctx *Context, args *GetOnPremiseVantagePointArgs, opts ...InvokeOption) (*GetOnPremiseVantagePointResult, error)
func GetOnPremiseVantagePointOutput(ctx *Context, args *GetOnPremiseVantagePointOutputArgs, opts ...InvokeOption) GetOnPremiseVantagePointResultOutput

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

    public static class GetOnPremiseVantagePoint 
{
    public static Task<GetOnPremiseVantagePointResult> InvokeAsync(GetOnPremiseVantagePointArgs args, InvokeOptions? opts = null)
    public static Output<GetOnPremiseVantagePointResult> Invoke(GetOnPremiseVantagePointInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOnPremiseVantagePointResult> getOnPremiseVantagePoint(GetOnPremiseVantagePointArgs args, InvokeOptions options)
public static Output<GetOnPremiseVantagePointResult> getOnPremiseVantagePoint(GetOnPremiseVantagePointArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:ApmSynthetics/getOnPremiseVantagePoint:getOnPremiseVantagePoint
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ApmDomainId string
    The APM domain ID the request is intended for.
    OnPremiseVantagePointId string
    The OCID of the On-premise vantage point.
    ApmDomainId string
    The APM domain ID the request is intended for.
    OnPremiseVantagePointId string
    The OCID of the On-premise vantage point.
    apmDomainId String
    The APM domain ID the request is intended for.
    onPremiseVantagePointId String
    The OCID of the On-premise vantage point.
    apmDomainId string
    The APM domain ID the request is intended for.
    onPremiseVantagePointId string
    The OCID of the On-premise vantage point.
    apm_domain_id str
    The APM domain ID the request is intended for.
    on_premise_vantage_point_id str
    The OCID of the On-premise vantage point.
    apmDomainId String
    The APM domain ID the request is intended for.
    onPremiseVantagePointId String
    The OCID of the On-premise vantage point.

    getOnPremiseVantagePoint Result

    The following output properties are available:

    ApmDomainId string
    DefinedTags Dictionary<string, string>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    A short description about the On-premise vantage point.
    DisplayName string
    Unique permanent name of the On-premise vantage point.
    FreeformTags 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 string
    The OCID of the On-premise vantage point.
    Name string
    Unique On-premise vantage point name that cannot be edited. The name should not contain any confidential information.
    OnPremiseVantagePointId string
    TimeCreated string
    The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    TimeUpdated string
    The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
    Type string
    Type of On-premise vantage point.
    WorkersSummaries List<GetOnPremiseVantagePointWorkersSummary>
    Details of the workers in a specific On-premise vantage point.
    ApmDomainId string
    DefinedTags map[string]string
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    Description string
    A short description about the On-premise vantage point.
    DisplayName string
    Unique permanent name of the On-premise vantage point.
    FreeformTags 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 string
    The OCID of the On-premise vantage point.
    Name string
    Unique On-premise vantage point name that cannot be edited. The name should not contain any confidential information.
    OnPremiseVantagePointId string
    TimeCreated string
    The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    TimeUpdated string
    The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
    Type string
    Type of On-premise vantage point.
    WorkersSummaries []GetOnPremiseVantagePointWorkersSummary
    Details of the workers in a specific On-premise vantage point.
    apmDomainId String
    definedTags Map<String,String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    A short description about the On-premise vantage point.
    displayName String
    Unique permanent name of the On-premise vantage point.
    freeformTags 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 String
    The OCID of the On-premise vantage point.
    name String
    Unique On-premise vantage point name that cannot be edited. The name should not contain any confidential information.
    onPremiseVantagePointId String
    timeCreated String
    The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    timeUpdated String
    The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
    type String
    Type of On-premise vantage point.
    workersSummaries List<GetOnPremiseVantagePointWorkersSummary>
    Details of the workers in a specific On-premise vantage point.
    apmDomainId string
    definedTags {[key: string]: string}
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description string
    A short description about the On-premise vantage point.
    displayName string
    Unique permanent name of the On-premise vantage point.
    freeformTags {[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 string
    The OCID of the On-premise vantage point.
    name string
    Unique On-premise vantage point name that cannot be edited. The name should not contain any confidential information.
    onPremiseVantagePointId string
    timeCreated string
    The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    timeUpdated string
    The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
    type string
    Type of On-premise vantage point.
    workersSummaries GetOnPremiseVantagePointWorkersSummary[]
    Details of the workers in a specific On-premise vantage point.
    apm_domain_id str
    defined_tags Mapping[str, str]
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description str
    A short description about the On-premise vantage point.
    display_name str
    Unique permanent name of the On-premise vantage point.
    freeform_tags 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 str
    The OCID of the On-premise vantage point.
    name str
    Unique On-premise vantage point name that cannot be edited. The name should not contain any confidential information.
    on_premise_vantage_point_id str
    time_created str
    The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    time_updated str
    The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
    type str
    Type of On-premise vantage point.
    workers_summaries Sequence[apmsynthetics.GetOnPremiseVantagePointWorkersSummary]
    Details of the workers in a specific On-premise vantage point.
    apmDomainId String
    definedTags Map<String>
    Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
    description String
    A short description about the On-premise vantage point.
    displayName String
    Unique permanent name of the On-premise vantage point.
    freeformTags 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 String
    The OCID of the On-premise vantage point.
    name String
    Unique On-premise vantage point name that cannot be edited. The name should not contain any confidential information.
    onPremiseVantagePointId String
    timeCreated String
    The time the resource was created, expressed in RFC 3339 timestamp format. Example: 2020-02-12T22:47:12.613Z
    timeUpdated String
    The time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2020-02-13T22:47:12.613Z
    type String
    Type of On-premise vantage point.
    workersSummaries List<Property Map>
    Details of the workers in a specific On-premise vantage point.

    Supporting Types

    GetOnPremiseVantagePointWorkersSummary

    Available int
    Number of available workers in a specific On-premise vantage point.
    AvailableCapabilities List<GetOnPremiseVantagePointWorkersSummaryAvailableCapability>
    List of available capabilities in a specific On-premise vantage point.
    Disabled int
    Number of disabled workers in a specific On-premise vantage point.
    MinVersion string
    Minimum version among the workers in a specific On-premise vantage point.
    Total int
    Total number of workers in a specific On-premise vantage point.
    Used int
    Number of occupied workers in a specific On-premise vantage point.
    Available int
    Number of available workers in a specific On-premise vantage point.
    AvailableCapabilities []GetOnPremiseVantagePointWorkersSummaryAvailableCapability
    List of available capabilities in a specific On-premise vantage point.
    Disabled int
    Number of disabled workers in a specific On-premise vantage point.
    MinVersion string
    Minimum version among the workers in a specific On-premise vantage point.
    Total int
    Total number of workers in a specific On-premise vantage point.
    Used int
    Number of occupied workers in a specific On-premise vantage point.
    available Integer
    Number of available workers in a specific On-premise vantage point.
    availableCapabilities List<GetOnPremiseVantagePointWorkersSummaryAvailableCapability>
    List of available capabilities in a specific On-premise vantage point.
    disabled Integer
    Number of disabled workers in a specific On-premise vantage point.
    minVersion String
    Minimum version among the workers in a specific On-premise vantage point.
    total Integer
    Total number of workers in a specific On-premise vantage point.
    used Integer
    Number of occupied workers in a specific On-premise vantage point.
    available number
    Number of available workers in a specific On-premise vantage point.
    availableCapabilities GetOnPremiseVantagePointWorkersSummaryAvailableCapability[]
    List of available capabilities in a specific On-premise vantage point.
    disabled number
    Number of disabled workers in a specific On-premise vantage point.
    minVersion string
    Minimum version among the workers in a specific On-premise vantage point.
    total number
    Total number of workers in a specific On-premise vantage point.
    used number
    Number of occupied workers in a specific On-premise vantage point.
    available int
    Number of available workers in a specific On-premise vantage point.
    available_capabilities Sequence[apmsynthetics.GetOnPremiseVantagePointWorkersSummaryAvailableCapability]
    List of available capabilities in a specific On-premise vantage point.
    disabled int
    Number of disabled workers in a specific On-premise vantage point.
    min_version str
    Minimum version among the workers in a specific On-premise vantage point.
    total int
    Total number of workers in a specific On-premise vantage point.
    used int
    Number of occupied workers in a specific On-premise vantage point.
    available Number
    Number of available workers in a specific On-premise vantage point.
    availableCapabilities List<Property Map>
    List of available capabilities in a specific On-premise vantage point.
    disabled Number
    Number of disabled workers in a specific On-premise vantage point.
    minVersion String
    Minimum version among the workers in a specific On-premise vantage point.
    total Number
    Total number of workers in a specific On-premise vantage point.
    used Number
    Number of occupied workers in a specific On-premise vantage point.

    GetOnPremiseVantagePointWorkersSummaryAvailableCapability

    Capability string
    Capability of an On-premise vantage point worker.
    OnPremiseVantagePointCount int
    Count of available capability in a specific On-premise vantage point.
    Capability string
    Capability of an On-premise vantage point worker.
    OnPremiseVantagePointCount int
    Count of available capability in a specific On-premise vantage point.
    capability String
    Capability of an On-premise vantage point worker.
    onPremiseVantagePointCount Integer
    Count of available capability in a specific On-premise vantage point.
    capability string
    Capability of an On-premise vantage point worker.
    onPremiseVantagePointCount number
    Count of available capability in a specific On-premise vantage point.
    capability str
    Capability of an On-premise vantage point worker.
    on_premise_vantage_point_count int
    Count of available capability in a specific On-premise vantage point.
    capability String
    Capability of an On-premise vantage point worker.
    onPremiseVantagePointCount Number
    Count of available capability in a specific On-premise vantage point.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.27.0 published on Thursday, Mar 20, 2025 by Pulumi
    pulumi/pulumi-oci