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

oci.ApmSynthetics.getOnPremiseVantagePoints

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 the list of On Premise Vantage Points in Oracle Cloud Infrastructure APM Availability Monitoring service (aka APM Synthetics Service).

    Returns a list of On-premise vantage points.

    Example Usage

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

const testOnPremiseVantagePoints = oci.ApmSynthetics.getOnPremiseVantagePoints({
    apmDomainId: testApmDomain.id,
    displayName: onPremiseVantagePointDisplayName,
    name: onPremiseVantagePointName,
});

    import pulumi
import pulumi_oci as oci

test_on_premise_vantage_points = oci.ApmSynthetics.get_on_premise_vantage_points(apm_domain_id=test_apm_domain["id"],
    display_name=on_premise_vantage_point_display_name,
    name=on_premise_vantage_point_name)

    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.GetOnPremiseVantagePoints(ctx, &apmsynthetics.GetOnPremiseVantagePointsArgs{
			ApmDomainId: testApmDomain.Id,
			DisplayName: pulumi.StringRef(onPremiseVantagePointDisplayName),
			Name:        pulumi.StringRef(onPremiseVantagePointName),
		}, 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 testOnPremiseVantagePoints = Oci.ApmSynthetics.GetOnPremiseVantagePoints.Invoke(new()
    {
        ApmDomainId = testApmDomain.Id,
        DisplayName = onPremiseVantagePointDisplayName,
        Name = onPremiseVantagePointName,
    });

});

    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.GetOnPremiseVantagePointsArgs;
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 testOnPremiseVantagePoints = ApmSyntheticsFunctions.getOnPremiseVantagePoints(GetOnPremiseVantagePointsArgs.builder()
            .apmDomainId(testApmDomain.id())
            .displayName(onPremiseVantagePointDisplayName)
            .name(onPremiseVantagePointName)
            .build());

    }
}

    variables:
  testOnPremiseVantagePoints:
    fn::invoke:
      function: oci:ApmSynthetics:getOnPremiseVantagePoints
      arguments:
        apmDomainId: ${testApmDomain.id}
        displayName: ${onPremiseVantagePointDisplayName}
        name: ${onPremiseVantagePointName}

    Using getOnPremiseVantagePoints

    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 getOnPremiseVantagePoints(args: GetOnPremiseVantagePointsArgs, opts?: InvokeOptions): Promise<GetOnPremiseVantagePointsResult>
function getOnPremiseVantagePointsOutput(args: GetOnPremiseVantagePointsOutputArgs, opts?: InvokeOptions): Output<GetOnPremiseVantagePointsResult>
    def get_on_premise_vantage_points(apm_domain_id: Optional[str] = None,
                                  display_name: Optional[str] = None,
                                  filters: Optional[Sequence[_apmsynthetics.GetOnPremiseVantagePointsFilter]] = None,
                                  name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetOnPremiseVantagePointsResult
def get_on_premise_vantage_points_output(apm_domain_id: Optional[pulumi.Input[str]] = None,
                                  display_name: Optional[pulumi.Input[str]] = None,
                                  filters: Optional[pulumi.Input[Sequence[pulumi.Input[_apmsynthetics.GetOnPremiseVantagePointsFilterArgs]]]] = None,
                                  name: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetOnPremiseVantagePointsResult]
    func GetOnPremiseVantagePoints(ctx *Context, args *GetOnPremiseVantagePointsArgs, opts ...InvokeOption) (*GetOnPremiseVantagePointsResult, error)
func GetOnPremiseVantagePointsOutput(ctx *Context, args *GetOnPremiseVantagePointsOutputArgs, opts ...InvokeOption) GetOnPremiseVantagePointsResultOutput

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

    public static class GetOnPremiseVantagePoints 
{
    public static Task<GetOnPremiseVantagePointsResult> InvokeAsync(GetOnPremiseVantagePointsArgs args, InvokeOptions? opts = null)
    public static Output<GetOnPremiseVantagePointsResult> Invoke(GetOnPremiseVantagePointsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOnPremiseVantagePointsResult> getOnPremiseVantagePoints(GetOnPremiseVantagePointsArgs args, InvokeOptions options)
public static Output<GetOnPremiseVantagePointsResult> getOnPremiseVantagePoints(GetOnPremiseVantagePointsArgs args, InvokeOptions options)

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

    The following arguments are supported:

    ApmDomainId string
    The APM domain ID the request is intended for.
    DisplayName string
    A filter to return only the resources that match the entire display name.
    Filters List<GetOnPremiseVantagePointsFilter>
    Name string
    A filter to return only the resources that match the entire name.
    ApmDomainId string
    The APM domain ID the request is intended for.
    DisplayName string
    A filter to return only the resources that match the entire display name.
    Filters []GetOnPremiseVantagePointsFilter
    Name string
    A filter to return only the resources that match the entire name.
    apmDomainId String
    The APM domain ID the request is intended for.
    displayName String
    A filter to return only the resources that match the entire display name.
    filters List<GetOnPremiseVantagePointsFilter>
    name String
    A filter to return only the resources that match the entire name.
    apmDomainId string
    The APM domain ID the request is intended for.
    displayName string
    A filter to return only the resources that match the entire display name.
    filters GetOnPremiseVantagePointsFilter[]
    name string
    A filter to return only the resources that match the entire name.
    apm_domain_id 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 Sequence[apmsynthetics.GetOnPremiseVantagePointsFilter]
    name str
    A filter to return only the resources that match the entire name.
    apmDomainId String
    The APM domain ID the request is intended for.
    displayName String
    A filter to return only the resources that match the entire display name.
    filters List<Property Map>
    name String
    A filter to return only the resources that match the entire name.

    getOnPremiseVantagePoints Result

    The following output properties are available:

    ApmDomainId string
    Id string
    The provider-assigned unique ID for this managed resource.
    OnPremiseVantagePointCollections List<GetOnPremiseVantagePointsOnPremiseVantagePointCollection>
    The list of on_premise_vantage_point_collection.
    DisplayName string
    Unique permanent name of the On-premise vantage point.
    Filters List<GetOnPremiseVantagePointsFilter>
    Name string
    Unique On-premise vantage point name that cannot be edited. The name should not contain any confidential information.
    ApmDomainId string
    Id string
    The provider-assigned unique ID for this managed resource.
    OnPremiseVantagePointCollections []GetOnPremiseVantagePointsOnPremiseVantagePointCollection
    The list of on_premise_vantage_point_collection.
    DisplayName string
    Unique permanent name of the On-premise vantage point.
    Filters []GetOnPremiseVantagePointsFilter
    Name string
    Unique On-premise vantage point name that cannot be edited. The name should not contain any confidential information.
    apmDomainId String
    id String
    The provider-assigned unique ID for this managed resource.
    onPremiseVantagePointCollections List<GetOnPremiseVantagePointsOnPremiseVantagePointCollection>
    The list of on_premise_vantage_point_collection.
    displayName String
    Unique permanent name of the On-premise vantage point.
    filters List<GetOnPremiseVantagePointsFilter>
    name String
    Unique On-premise vantage point name that cannot be edited. The name should not contain any confidential information.
    apmDomainId string
    id string
    The provider-assigned unique ID for this managed resource.
    onPremiseVantagePointCollections GetOnPremiseVantagePointsOnPremiseVantagePointCollection[]
    The list of on_premise_vantage_point_collection.
    displayName string
    Unique permanent name of the On-premise vantage point.
    filters GetOnPremiseVantagePointsFilter[]
    name string
    Unique On-premise vantage point name that cannot be edited. The name should not contain any confidential information.
    apm_domain_id str
    id str
    The provider-assigned unique ID for this managed resource.
    on_premise_vantage_point_collections Sequence[apmsynthetics.GetOnPremiseVantagePointsOnPremiseVantagePointCollection]
    The list of on_premise_vantage_point_collection.
    display_name str
    Unique permanent name of the On-premise vantage point.
    filters Sequence[apmsynthetics.GetOnPremiseVantagePointsFilter]
    name str
    Unique On-premise vantage point name that cannot be edited. The name should not contain any confidential information.
    apmDomainId String
    id String
    The provider-assigned unique ID for this managed resource.
    onPremiseVantagePointCollections List<Property Map>
    The list of on_premise_vantage_point_collection.
    displayName String
    Unique permanent name of the On-premise vantage point.
    filters List<Property Map>
    name String
    Unique On-premise vantage point name that cannot be edited. The name should not contain any confidential information.

    Supporting Types

    GetOnPremiseVantagePointsFilter

    Name string
    A filter to return only the resources that match the entire name.
    Values List<string>
    Regex bool
    Name string
    A filter to return only the resources that match the entire name.
    Values []string
    Regex bool
    name String
    A filter to return only the resources that match the entire name.
    values List<String>
    regex Boolean
    name string
    A filter to return only the resources that match the entire name.
    values string[]
    regex boolean
    name str
    A filter to return only the resources that match the entire name.
    values Sequence[str]
    regex bool
    name String
    A filter to return only the resources that match the entire name.
    values List<String>
    regex Boolean

    GetOnPremiseVantagePointsOnPremiseVantagePointCollection

    GetOnPremiseVantagePointsOnPremiseVantagePointCollectionItem

    ApmDomainId string
    The APM domain ID the request is intended for.
    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
    A filter to return only the resources that match the entire display name.
    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
    A filter to return only the resources that match the entire name.
    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<GetOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummary>
    Details of the workers in a specific On-premise vantage point.
    ApmDomainId string
    The APM domain ID the request is intended for.
    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
    A filter to return only the resources that match the entire display name.
    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
    A filter to return only the resources that match the entire name.
    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 []GetOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummary
    Details of the workers in a specific On-premise vantage point.
    apmDomainId String
    The APM domain ID the request is intended for.
    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
    A filter to return only the resources that match the entire display name.
    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
    A filter to return only the resources that match the entire name.
    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<GetOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummary>
    Details of the workers in a specific On-premise vantage point.
    apmDomainId string
    The APM domain ID the request is intended for.
    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
    A filter to return only the resources that match the entire display name.
    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
    A filter to return only the resources that match the entire name.
    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 GetOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummary[]
    Details of the workers in a specific On-premise vantage point.
    apm_domain_id str
    The APM domain ID the request is intended for.
    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
    A filter to return only the resources that match the entire display name.
    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
    A filter to return only the resources that match the entire name.
    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.GetOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummary]
    Details of the workers in a specific On-premise vantage point.
    apmDomainId String
    The APM domain ID the request is intended for.
    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
    A filter to return only the resources that match the entire display name.
    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
    A filter to return only the resources that match the entire name.
    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.

    GetOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummary

    Available int
    Number of available workers in a specific On-premise vantage point.
    AvailableCapabilities List<GetOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummaryAvailableCapability>
    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 []GetOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummaryAvailableCapability
    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<GetOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummaryAvailableCapability>
    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 GetOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummaryAvailableCapability[]
    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.GetOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummaryAvailableCapability]
    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.

    GetOnPremiseVantagePointsOnPremiseVantagePointCollectionItemWorkersSummaryAvailableCapability

    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