1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. HealthChecks
  5. getVantagePoints
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

oci.HealthChecks.getVantagePoints

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi

This data source provides the list of Vantage Points in Oracle Cloud Infrastructure Health Checks service.

Gets information about all vantage points available to the user.

Example Usage

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

const testVantagePoints = oci.HealthChecks.getVantagePoints({
    displayName: vantagePointDisplayName,
    name: vantagePointName,
});
Copy
import pulumi
import pulumi_oci as oci

test_vantage_points = oci.HealthChecks.get_vantage_points(display_name=vantage_point_display_name,
    name=vantage_point_name)
Copy
package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/healthchecks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := healthchecks.GetVantagePoints(ctx, &healthchecks.GetVantagePointsArgs{
			DisplayName: pulumi.StringRef(vantagePointDisplayName),
			Name:        pulumi.StringRef(vantagePointName),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testVantagePoints = Oci.HealthChecks.GetVantagePoints.Invoke(new()
    {
        DisplayName = vantagePointDisplayName,
        Name = vantagePointName,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.HealthChecks.HealthChecksFunctions;
import com.pulumi.oci.HealthChecks.inputs.GetVantagePointsArgs;
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 testVantagePoints = HealthChecksFunctions.getVantagePoints(GetVantagePointsArgs.builder()
            .displayName(vantagePointDisplayName)
            .name(vantagePointName)
            .build());

    }
}
Copy
variables:
  testVantagePoints:
    fn::invoke:
      function: oci:HealthChecks:getVantagePoints
      arguments:
        displayName: ${vantagePointDisplayName}
        name: ${vantagePointName}
Copy

Using getVantagePoints

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 getVantagePoints(args: GetVantagePointsArgs, opts?: InvokeOptions): Promise<GetVantagePointsResult>
function getVantagePointsOutput(args: GetVantagePointsOutputArgs, opts?: InvokeOptions): Output<GetVantagePointsResult>
Copy
def get_vantage_points(display_name: Optional[str] = None,
                       filters: Optional[Sequence[_healthchecks.GetVantagePointsFilter]] = None,
                       name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetVantagePointsResult
def get_vantage_points_output(display_name: Optional[pulumi.Input[str]] = None,
                       filters: Optional[pulumi.Input[Sequence[pulumi.Input[_healthchecks.GetVantagePointsFilterArgs]]]] = None,
                       name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetVantagePointsResult]
Copy
func GetVantagePoints(ctx *Context, args *GetVantagePointsArgs, opts ...InvokeOption) (*GetVantagePointsResult, error)
func GetVantagePointsOutput(ctx *Context, args *GetVantagePointsOutputArgs, opts ...InvokeOption) GetVantagePointsResultOutput
Copy

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

public static class GetVantagePoints 
{
    public static Task<GetVantagePointsResult> InvokeAsync(GetVantagePointsArgs args, InvokeOptions? opts = null)
    public static Output<GetVantagePointsResult> Invoke(GetVantagePointsInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVantagePointsResult> getVantagePoints(GetVantagePointsArgs args, InvokeOptions options)
public static Output<GetVantagePointsResult> getVantagePoints(GetVantagePointsArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: oci:HealthChecks/getVantagePoints:getVantagePoints
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DisplayName string
Filters results that exactly match the displayName field.
Filters Changes to this property will trigger replacement. List<GetVantagePointsFilter>
Name string
Filters results that exactly match the name field.
DisplayName string
Filters results that exactly match the displayName field.
Filters Changes to this property will trigger replacement. []GetVantagePointsFilter
Name string
Filters results that exactly match the name field.
displayName String
Filters results that exactly match the displayName field.
filters Changes to this property will trigger replacement. List<GetVantagePointsFilter>
name String
Filters results that exactly match the name field.
displayName string
Filters results that exactly match the displayName field.
filters Changes to this property will trigger replacement. GetVantagePointsFilter[]
name string
Filters results that exactly match the name field.
display_name str
Filters results that exactly match the displayName field.
filters Changes to this property will trigger replacement. Sequence[healthchecks.GetVantagePointsFilter]
name str
Filters results that exactly match the name field.
displayName String
Filters results that exactly match the displayName field.
filters Changes to this property will trigger replacement. List<Property Map>
name String
Filters results that exactly match the name field.

getVantagePoints Result

The following output properties are available:

HealthChecksVantagePoints List<GetVantagePointsHealthChecksVantagePoint>
The list of health_checks_vantage_points.
Id string
The provider-assigned unique ID for this managed resource.
DisplayName string
The display name for the vantage point. Display names are determined by the best information available and may change over time.
Filters List<GetVantagePointsFilter>
Name string
The unique, permanent name for the vantage point.
HealthChecksVantagePoints []GetVantagePointsHealthChecksVantagePoint
The list of health_checks_vantage_points.
Id string
The provider-assigned unique ID for this managed resource.
DisplayName string
The display name for the vantage point. Display names are determined by the best information available and may change over time.
Filters []GetVantagePointsFilter
Name string
The unique, permanent name for the vantage point.
healthChecksVantagePoints List<GetVantagePointsVantagePoint>
The list of health_checks_vantage_points.
id String
The provider-assigned unique ID for this managed resource.
displayName String
The display name for the vantage point. Display names are determined by the best information available and may change over time.
filters List<GetVantagePointsFilter>
name String
The unique, permanent name for the vantage point.
healthChecksVantagePoints GetVantagePointsHealthChecksVantagePoint[]
The list of health_checks_vantage_points.
id string
The provider-assigned unique ID for this managed resource.
displayName string
The display name for the vantage point. Display names are determined by the best information available and may change over time.
filters GetVantagePointsFilter[]
name string
The unique, permanent name for the vantage point.
health_checks_vantage_points Sequence[healthchecks.GetVantagePointsHealthChecksVantagePoint]
The list of health_checks_vantage_points.
id str
The provider-assigned unique ID for this managed resource.
display_name str
The display name for the vantage point. Display names are determined by the best information available and may change over time.
filters Sequence[healthchecks.GetVantagePointsFilter]
name str
The unique, permanent name for the vantage point.
healthChecksVantagePoints List<Property Map>
The list of health_checks_vantage_points.
id String
The provider-assigned unique ID for this managed resource.
displayName String
The display name for the vantage point. Display names are determined by the best information available and may change over time.
filters List<Property Map>
name String
The unique, permanent name for the vantage point.

Supporting Types

GetVantagePointsFilter

Name This property is required. string
Filters results that exactly match the name field.
Values This property is required. List<string>
Regex bool
Name This property is required. string
Filters results that exactly match the name field.
Values This property is required. []string
Regex bool
name This property is required. String
Filters results that exactly match the name field.
values This property is required. List<String>
regex Boolean
name This property is required. string
Filters results that exactly match the name field.
values This property is required. string[]
regex boolean
name This property is required. str
Filters results that exactly match the name field.
values This property is required. Sequence[str]
regex bool
name This property is required. String
Filters results that exactly match the name field.
values This property is required. List<String>
regex Boolean

GetVantagePointsHealthChecksVantagePoint

DisplayName This property is required. string
Filters results that exactly match the displayName field.
Geos This property is required. List<GetVantagePointsHealthChecksVantagePointGeo>
Geographic information about a vantage point.
Name This property is required. string
Filters results that exactly match the name field.
ProviderName This property is required. string
The organization on whose infrastructure this vantage point resides. Provider names are not unique, as Oracle Cloud Infrastructure maintains many vantage points in each major provider.
Routings This property is required. List<GetVantagePointsHealthChecksVantagePointRouting>
An array of objects that describe how traffic to this vantage point is routed, including which prefixes and ASNs connect it to the internet.
DisplayName This property is required. string
Filters results that exactly match the displayName field.
Geos This property is required. []GetVantagePointsHealthChecksVantagePointGeo
Geographic information about a vantage point.
Name This property is required. string
Filters results that exactly match the name field.
ProviderName This property is required. string
The organization on whose infrastructure this vantage point resides. Provider names are not unique, as Oracle Cloud Infrastructure maintains many vantage points in each major provider.
Routings This property is required. []GetVantagePointsHealthChecksVantagePointRouting
An array of objects that describe how traffic to this vantage point is routed, including which prefixes and ASNs connect it to the internet.
displayName This property is required. String
Filters results that exactly match the displayName field.
geos This property is required. List<GetVantagePointsVantagePointGeo>
Geographic information about a vantage point.
name This property is required. String
Filters results that exactly match the name field.
providerName This property is required. String
The organization on whose infrastructure this vantage point resides. Provider names are not unique, as Oracle Cloud Infrastructure maintains many vantage points in each major provider.
routings This property is required. List<GetVantagePointsVantagePointRouting>
An array of objects that describe how traffic to this vantage point is routed, including which prefixes and ASNs connect it to the internet.
displayName This property is required. string
Filters results that exactly match the displayName field.
geos This property is required. GetVantagePointsHealthChecksVantagePointGeo[]
Geographic information about a vantage point.
name This property is required. string
Filters results that exactly match the name field.
providerName This property is required. string
The organization on whose infrastructure this vantage point resides. Provider names are not unique, as Oracle Cloud Infrastructure maintains many vantage points in each major provider.
routings This property is required. GetVantagePointsHealthChecksVantagePointRouting[]
An array of objects that describe how traffic to this vantage point is routed, including which prefixes and ASNs connect it to the internet.
display_name This property is required. str
Filters results that exactly match the displayName field.
geos This property is required. Sequence[healthchecks.GetVantagePointsHealthChecksVantagePointGeo]
Geographic information about a vantage point.
name This property is required. str
Filters results that exactly match the name field.
provider_name This property is required. str
The organization on whose infrastructure this vantage point resides. Provider names are not unique, as Oracle Cloud Infrastructure maintains many vantage points in each major provider.
routings This property is required. Sequence[healthchecks.GetVantagePointsHealthChecksVantagePointRouting]
An array of objects that describe how traffic to this vantage point is routed, including which prefixes and ASNs connect it to the internet.
displayName This property is required. String
Filters results that exactly match the displayName field.
geos This property is required. List<Property Map>
Geographic information about a vantage point.
name This property is required. String
Filters results that exactly match the name field.
providerName This property is required. String
The organization on whose infrastructure this vantage point resides. Provider names are not unique, as Oracle Cloud Infrastructure maintains many vantage points in each major provider.
routings This property is required. List<Property Map>
An array of objects that describe how traffic to this vantage point is routed, including which prefixes and ASNs connect it to the internet.

GetVantagePointsHealthChecksVantagePointGeo

AdminDivCode This property is required. string
The ISO 3166-2 code for this location's first-level administrative division, either a US state or Canadian province. Only included for locations in the US or Canada. For a list of codes, see Country Codes.
CityName This property is required. string
Common English-language name for the city.
CountryCode This property is required. string
The ISO 3166-1 alpha-2 country code. For a list of codes, see Country Codes.
CountryName This property is required. string
The common English-language name for the country.
GeoKey This property is required. string
An opaque identifier for the geographic location of the vantage point.
Latitude This property is required. double
Degrees north of the Equator.
Longitude This property is required. double
Degrees east of the prime meridian.
AdminDivCode This property is required. string
The ISO 3166-2 code for this location's first-level administrative division, either a US state or Canadian province. Only included for locations in the US or Canada. For a list of codes, see Country Codes.
CityName This property is required. string
Common English-language name for the city.
CountryCode This property is required. string
The ISO 3166-1 alpha-2 country code. For a list of codes, see Country Codes.
CountryName This property is required. string
The common English-language name for the country.
GeoKey This property is required. string
An opaque identifier for the geographic location of the vantage point.
Latitude This property is required. float64
Degrees north of the Equator.
Longitude This property is required. float64
Degrees east of the prime meridian.
adminDivCode This property is required. String
The ISO 3166-2 code for this location's first-level administrative division, either a US state or Canadian province. Only included for locations in the US or Canada. For a list of codes, see Country Codes.
cityName This property is required. String
Common English-language name for the city.
countryCode This property is required. String
The ISO 3166-1 alpha-2 country code. For a list of codes, see Country Codes.
countryName This property is required. String
The common English-language name for the country.
geoKey This property is required. String
An opaque identifier for the geographic location of the vantage point.
latitude This property is required. Double
Degrees north of the Equator.
longitude This property is required. Double
Degrees east of the prime meridian.
adminDivCode This property is required. string
The ISO 3166-2 code for this location's first-level administrative division, either a US state or Canadian province. Only included for locations in the US or Canada. For a list of codes, see Country Codes.
cityName This property is required. string
Common English-language name for the city.
countryCode This property is required. string
The ISO 3166-1 alpha-2 country code. For a list of codes, see Country Codes.
countryName This property is required. string
The common English-language name for the country.
geoKey This property is required. string
An opaque identifier for the geographic location of the vantage point.
latitude This property is required. number
Degrees north of the Equator.
longitude This property is required. number
Degrees east of the prime meridian.
admin_div_code This property is required. str
The ISO 3166-2 code for this location's first-level administrative division, either a US state or Canadian province. Only included for locations in the US or Canada. For a list of codes, see Country Codes.
city_name This property is required. str
Common English-language name for the city.
country_code This property is required. str
The ISO 3166-1 alpha-2 country code. For a list of codes, see Country Codes.
country_name This property is required. str
The common English-language name for the country.
geo_key This property is required. str
An opaque identifier for the geographic location of the vantage point.
latitude This property is required. float
Degrees north of the Equator.
longitude This property is required. float
Degrees east of the prime meridian.
adminDivCode This property is required. String
The ISO 3166-2 code for this location's first-level administrative division, either a US state or Canadian province. Only included for locations in the US or Canada. For a list of codes, see Country Codes.
cityName This property is required. String
Common English-language name for the city.
countryCode This property is required. String
The ISO 3166-1 alpha-2 country code. For a list of codes, see Country Codes.
countryName This property is required. String
The common English-language name for the country.
geoKey This property is required. String
An opaque identifier for the geographic location of the vantage point.
latitude This property is required. Number
Degrees north of the Equator.
longitude This property is required. Number
Degrees east of the prime meridian.

GetVantagePointsHealthChecksVantagePointRouting

AsLabel This property is required. string
The registry label for asn, usually the name of the organization that owns the ASN. May be omitted or null.
Asn This property is required. int
The Autonomous System Number (ASN) identifying the organization responsible for routing packets to prefix.
Prefix This property is required. string
An IP prefix (CIDR syntax) that is less specific than address, through which address is routed.
Weight This property is required. int
An integer between 0 and 100 used to select between multiple origin ASNs when routing to prefix. Most prefixes have exactly one origin ASN, in which case weight will be 100.
AsLabel This property is required. string
The registry label for asn, usually the name of the organization that owns the ASN. May be omitted or null.
Asn This property is required. int
The Autonomous System Number (ASN) identifying the organization responsible for routing packets to prefix.
Prefix This property is required. string
An IP prefix (CIDR syntax) that is less specific than address, through which address is routed.
Weight This property is required. int
An integer between 0 and 100 used to select between multiple origin ASNs when routing to prefix. Most prefixes have exactly one origin ASN, in which case weight will be 100.
asLabel This property is required. String
The registry label for asn, usually the name of the organization that owns the ASN. May be omitted or null.
asn This property is required. Integer
The Autonomous System Number (ASN) identifying the organization responsible for routing packets to prefix.
prefix This property is required. String
An IP prefix (CIDR syntax) that is less specific than address, through which address is routed.
weight This property is required. Integer
An integer between 0 and 100 used to select between multiple origin ASNs when routing to prefix. Most prefixes have exactly one origin ASN, in which case weight will be 100.
asLabel This property is required. string
The registry label for asn, usually the name of the organization that owns the ASN. May be omitted or null.
asn This property is required. number
The Autonomous System Number (ASN) identifying the organization responsible for routing packets to prefix.
prefix This property is required. string
An IP prefix (CIDR syntax) that is less specific than address, through which address is routed.
weight This property is required. number
An integer between 0 and 100 used to select between multiple origin ASNs when routing to prefix. Most prefixes have exactly one origin ASN, in which case weight will be 100.
as_label This property is required. str
The registry label for asn, usually the name of the organization that owns the ASN. May be omitted or null.
asn This property is required. int
The Autonomous System Number (ASN) identifying the organization responsible for routing packets to prefix.
prefix This property is required. str
An IP prefix (CIDR syntax) that is less specific than address, through which address is routed.
weight This property is required. int
An integer between 0 and 100 used to select between multiple origin ASNs when routing to prefix. Most prefixes have exactly one origin ASN, in which case weight will be 100.
asLabel This property is required. String
The registry label for asn, usually the name of the organization that owns the ASN. May be omitted or null.
asn This property is required. Number
The Autonomous System Number (ASN) identifying the organization responsible for routing packets to prefix.
prefix This property is required. String
An IP prefix (CIDR syntax) that is less specific than address, through which address is routed.
weight This property is required. Number
An integer between 0 and 100 used to select between multiple origin ASNs when routing to prefix. Most prefixes have exactly one origin ASN, in which case weight will be 100.

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes
This Pulumi package is based on the oci Terraform Provider.
Oracle Cloud Infrastructure v2.30.0 published on Monday, Apr 14, 2025 by Pulumi