Oracle Cloud Infrastructure v0.13.0, Mar 28 23

oci.HealthChecks.getVantagePoints

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

using System.Collections.Generic;
using Pulumi;
using Oci = Pulumi.Oci;

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

});

package main

import (
	"github.com/pulumi/pulumi-oci/sdk/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(_var.Vantage_point_display_name),
			Name:        pulumi.StringRef(_var.Vantage_point_name),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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(var_.vantage_point_display_name())
            .name(var_.vantage_point_name())
            .build());

    }
}

import pulumi
import pulumi_oci as oci

test_vantage_points = oci.HealthChecks.get_vantage_points(display_name=var["vantage_point_display_name"],
    name=var["vantage_point_name"])

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

const testVantagePoints = oci.HealthChecks.getVantagePoints({
    displayName: _var.vantage_point_display_name,
    name: _var.vantage_point_name,
});

variables:
  testVantagePoints:
    fn::invoke:
      Function: oci:HealthChecks:getVantagePoints
      Arguments:
        displayName: ${var.vantage_point_display_name}
        name: ${var.vantage_point_name}

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>

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]

func GetVantagePoints(ctx *Context, args *GetVantagePointsArgs, opts ...InvokeOption) (*GetVantagePointsResult, error)
func GetVantagePointsOutput(ctx *Context, args *GetVantagePointsOutputArgs, opts ...InvokeOption) GetVantagePointsResultOutput

> 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)
}

public static CompletableFuture<GetVantagePointsResult> getVantagePoints(GetVantagePointsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: oci:HealthChecks/getVantagePoints:getVantagePoints
  arguments:
    # arguments dictionary

The following arguments are supported:

DisplayName string: Filters results that exactly match the displayName field.
Filters List<GetVantagePointsFilter>
Name string: Filters results that exactly match the name field.

DisplayName string: Filters results that exactly match the displayName field.
Filters []GetVantagePointsFilter
Name string: Filters results that exactly match the name field.

displayName String: Filters results that exactly match the displayName field.
filters List<GetVantagePointsFilter>
name String: Filters results that exactly match the name field.

displayName string: Filters results that exactly match the displayName field.
filters GetVantagePointsFilter[]
name string: Filters results that exactly match the name field.

display_name str: Filters results that exactly match the displayName field.
filters GetVantagePointsFilter]
name str: Filters results that exactly match the name field.

displayName String: Filters results that exactly match the displayName field.
filters 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 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 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 string: Filters results that exactly match the name field.
Values List<string>
Regex bool

Name string: Filters results that exactly match the name field.
Values []string
Regex bool

name String: Filters results that exactly match the name field.
values List<String>
regex Boolean

name string: Filters results that exactly match the name field.
values string[]
regex boolean

name str: Filters results that exactly match the name field.
values Sequence[str]
regex bool

name String: Filters results that exactly match the name field.
values List<String>
regex Boolean

GetVantagePointsHealthChecksVantagePoint

DisplayName string: Filters results that exactly match the displayName field.
Geos List<GetVantagePointsHealthChecksVantagePointGeo>: Geographic information about a vantage point.
Name string: Filters results that exactly match the name field.
ProviderName 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 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 string: Filters results that exactly match the displayName field.
Geos []GetVantagePointsHealthChecksVantagePointGeo: Geographic information about a vantage point.
Name string: Filters results that exactly match the name field.
ProviderName 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 []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 String: Filters results that exactly match the displayName field.
geos List<GetVantagePointsVantagePointGeo>: Geographic information about a vantage point.
name String: Filters results that exactly match the name field.
providerName 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 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 string: Filters results that exactly match the displayName field.
geos GetVantagePointsHealthChecksVantagePointGeo[]: Geographic information about a vantage point.
name string: Filters results that exactly match the name field.
providerName 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 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 str: Filters results that exactly match the displayName field.
geos GetVantagePointsHealthChecksVantagePointGeo]: Geographic information about a vantage point.
name str: Filters results that exactly match the name field.
provider_name 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 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 String: Filters results that exactly match the displayName field.
geos List<Property Map>: Geographic information about a vantage point.
name String: Filters results that exactly match the name field.
providerName 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 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 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 string: Common English-language name for the city.
CountryCode string: The ISO 3166-1 alpha-2 country code. For a list of codes, see Country Codes.
CountryName string: The common English-language name for the country.
GeoKey string: An opaque identifier for the geographic location of the vantage point.
Latitude double: Degrees north of the Equator.
Longitude double: Degrees east of the prime meridian.

AdminDivCode 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 string: Common English-language name for the city.
CountryCode string: The ISO 3166-1 alpha-2 country code. For a list of codes, see Country Codes.
CountryName string: The common English-language name for the country.
GeoKey string: An opaque identifier for the geographic location of the vantage point.
Latitude float64: Degrees north of the Equator.
Longitude float64: Degrees east of the prime meridian.

adminDivCode 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 String: Common English-language name for the city.
countryCode String: The ISO 3166-1 alpha-2 country code. For a list of codes, see Country Codes.
countryName String: The common English-language name for the country.
geoKey String: An opaque identifier for the geographic location of the vantage point.
latitude Double: Degrees north of the Equator.
longitude Double: Degrees east of the prime meridian.

adminDivCode 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 string: Common English-language name for the city.
countryCode string: The ISO 3166-1 alpha-2 country code. For a list of codes, see Country Codes.
countryName string: The common English-language name for the country.
geoKey string: An opaque identifier for the geographic location of the vantage point.
latitude number: Degrees north of the Equator.
longitude number: Degrees east of the prime meridian.

admin_div_code 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 str: Common English-language name for the city.
country_code str: The ISO 3166-1 alpha-2 country code. For a list of codes, see Country Codes.
country_name str: The common English-language name for the country.
geo_key str: An opaque identifier for the geographic location of the vantage point.
latitude float: Degrees north of the Equator.
longitude float: Degrees east of the prime meridian.

adminDivCode 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 String: Common English-language name for the city.
countryCode String: The ISO 3166-1 alpha-2 country code. For a list of codes, see Country Codes.
countryName String: The common English-language name for the country.
geoKey String: An opaque identifier for the geographic location of the vantage point.
latitude Number: Degrees north of the Equator.
longitude Number: Degrees east of the prime meridian.

GetVantagePointsHealthChecksVantagePointRouting

AsLabel string: The registry label for asn, usually the name of the organization that owns the ASN. May be omitted or null.
Asn int: The Autonomous System Number (ASN) identifying the organization responsible for routing packets to prefix.
Prefix string: An IP prefix (CIDR syntax) that is less specific than address, through which address is routed.
Weight 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 string: The registry label for asn, usually the name of the organization that owns the ASN. May be omitted or null.
Asn int: The Autonomous System Number (ASN) identifying the organization responsible for routing packets to prefix.
Prefix string: An IP prefix (CIDR syntax) that is less specific than address, through which address is routed.
Weight 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 String: The registry label for asn, usually the name of the organization that owns the ASN. May be omitted or null.
asn Integer: The Autonomous System Number (ASN) identifying the organization responsible for routing packets to prefix.
prefix String: An IP prefix (CIDR syntax) that is less specific than address, through which address is routed.
weight 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 string: The registry label for asn, usually the name of the organization that owns the ASN. May be omitted or null.
asn number: The Autonomous System Number (ASN) identifying the organization responsible for routing packets to prefix.
prefix string: An IP prefix (CIDR syntax) that is less specific than address, through which address is routed.
weight 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 str: The registry label for asn, usually the name of the organization that owns the ASN. May be omitted or null.
asn int: The Autonomous System Number (ASN) identifying the organization responsible for routing packets to prefix.
prefix str: An IP prefix (CIDR syntax) that is less specific than address, through which address is routed.
weight 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 String: The registry label for asn, usually the name of the organization that owns the ASN. May be omitted or null.
asn Number: The Autonomous System Number (ASN) identifying the organization responsible for routing packets to prefix.
prefix String: An IP prefix (CIDR syntax) that is less specific than address, through which address is routed.
weight 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.