Oracle Cloud Infrastructure

Pulumi Official
Package maintained by Pulumi
v0.1.1 published on Tuesday, May 3, 2022 by Pulumi

getPublicIpPools

This data source provides the list of Public Ip Pools in Oracle Cloud Infrastructure Core service.

Lists the public IP pools in the specified compartment. You can filter the list using query parameters.

Example Usage

using Pulumi;
using Oci = Pulumi.Oci;

class MyStack : Stack
{
    public MyStack()
    {
        var testPublicIpPools = Output.Create(Oci.Core.GetPublicIpPools.InvokeAsync(new Oci.Core.GetPublicIpPoolsArgs
        {
            CompartmentId = @var.Compartment_id,
            ByoipRangeId = oci_core_byoip_range.Test_byoip_range.Id,
            DisplayName = @var.Public_ip_pool_display_name,
        }));
    }

}
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Core.GetPublicIpPools(ctx, &core.GetPublicIpPoolsArgs{
			CompartmentId: _var.Compartment_id,
			ByoipRangeId:  pulumi.StringRef(oci_core_byoip_range.Test_byoip_range.Id),
			DisplayName:   pulumi.StringRef(_var.Public_ip_pool_display_name),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

Coming soon!

import pulumi
import pulumi_oci as oci

test_public_ip_pools = oci.Core.get_public_ip_pools(compartment_id=var["compartment_id"],
    byoip_range_id=oci_core_byoip_range["test_byoip_range"]["id"],
    display_name=var["public_ip_pool_display_name"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testPublicIpPools = oci.Core.getPublicIpPools({
    compartmentId: _var.compartment_id,
    byoipRangeId: oci_core_byoip_range.test_byoip_range.id,
    displayName: _var.public_ip_pool_display_name,
});

Coming soon!

Using getPublicIpPools

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 getPublicIpPools(args: GetPublicIpPoolsArgs, opts?: InvokeOptions): Promise<GetPublicIpPoolsResult>
function getPublicIpPoolsOutput(args: GetPublicIpPoolsOutputArgs, opts?: InvokeOptions): Output<GetPublicIpPoolsResult>
def get_public_ip_pools(byoip_range_id: Optional[str] = None,
                        compartment_id: Optional[str] = None,
                        display_name: Optional[str] = None,
                        filters: Optional[Sequence[_core.GetPublicIpPoolsFilter]] = None,
                        opts: Optional[InvokeOptions] = None) -> GetPublicIpPoolsResult
def get_public_ip_pools_output(byoip_range_id: Optional[pulumi.Input[str]] = None,
                        compartment_id: Optional[pulumi.Input[str]] = None,
                        display_name: Optional[pulumi.Input[str]] = None,
                        filters: Optional[pulumi.Input[Sequence[pulumi.Input[_core.GetPublicIpPoolsFilterArgs]]]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetPublicIpPoolsResult]
func GetPublicIpPools(ctx *Context, args *GetPublicIpPoolsArgs, opts ...InvokeOption) (*GetPublicIpPoolsResult, error)
func GetPublicIpPoolsOutput(ctx *Context, args *GetPublicIpPoolsOutputArgs, opts ...InvokeOption) GetPublicIpPoolsResultOutput

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

public static class GetPublicIpPools 
{
    public static Task<GetPublicIpPoolsResult> InvokeAsync(GetPublicIpPoolsArgs args, InvokeOptions? opts = null)
    public static Output<GetPublicIpPoolsResult> Invoke(GetPublicIpPoolsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPublicIpPoolsResult> getPublicIpPools(GetPublicIpPoolsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: oci:Core/getPublicIpPools:getPublicIpPools
  Arguments:
    # Arguments dictionary

The following arguments are supported:

CompartmentId string

The OCID of the compartment.

ByoipRangeId string

A filter to return only resources that match the given BYOIP CIDR block.

DisplayName string

A filter to return only resources that match the given display name exactly.

Filters List<GetPublicIpPoolsFilter>
CompartmentId string

The OCID of the compartment.

ByoipRangeId string

A filter to return only resources that match the given BYOIP CIDR block.

DisplayName string

A filter to return only resources that match the given display name exactly.

Filters []GetPublicIpPoolsFilter
compartmentId String

The OCID of the compartment.

byoipRangeId String

A filter to return only resources that match the given BYOIP CIDR block.

displayName String

A filter to return only resources that match the given display name exactly.

filters List<GetPublicIpPoolsFilter>
compartmentId string

The OCID of the compartment.

byoipRangeId string

A filter to return only resources that match the given BYOIP CIDR block.

displayName string

A filter to return only resources that match the given display name exactly.

filters GetPublicIpPoolsFilter[]
compartment_id str

The OCID of the compartment.

byoip_range_id str

A filter to return only resources that match the given BYOIP CIDR block.

display_name str

A filter to return only resources that match the given display name exactly.

filters GetPublicIpPoolsFilter]
compartmentId String

The OCID of the compartment.

byoipRangeId String

A filter to return only resources that match the given BYOIP CIDR block.

displayName String

A filter to return only resources that match the given display name exactly.

filters List<Property Map>

getPublicIpPools Result

The following output properties are available:

CompartmentId string

The OCID of the compartment containing this pool.

Id string

The provider-assigned unique ID for this managed resource.

PublicIpPoolCollections List<GetPublicIpPoolsPublicIpPoolCollection>

The list of public_ip_pool_collection.

ByoipRangeId string
DisplayName string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Filters List<GetPublicIpPoolsFilter>
CompartmentId string

The OCID of the compartment containing this pool.

Id string

The provider-assigned unique ID for this managed resource.

PublicIpPoolCollections []GetPublicIpPoolsPublicIpPoolCollection

The list of public_ip_pool_collection.

ByoipRangeId string
DisplayName string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Filters []GetPublicIpPoolsFilter
compartmentId String

The OCID of the compartment containing this pool.

id String

The provider-assigned unique ID for this managed resource.

publicIpPoolCollections List<GetPublicIpPoolsPublicIpPoolCollection>

The list of public_ip_pool_collection.

byoipRangeId String
displayName String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

filters List<GetPublicIpPoolsFilter>
compartmentId string

The OCID of the compartment containing this pool.

id string

The provider-assigned unique ID for this managed resource.

publicIpPoolCollections GetPublicIpPoolsPublicIpPoolCollection[]

The list of public_ip_pool_collection.

byoipRangeId string
displayName string

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

filters GetPublicIpPoolsFilter[]
compartment_id str

The OCID of the compartment containing this pool.

id str

The provider-assigned unique ID for this managed resource.

public_ip_pool_collections GetPublicIpPoolsPublicIpPoolCollection]

The list of public_ip_pool_collection.

byoip_range_id str
display_name str

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

filters GetPublicIpPoolsFilter]
compartmentId String

The OCID of the compartment containing this pool.

id String

The provider-assigned unique ID for this managed resource.

publicIpPoolCollections List<Property Map>

The list of public_ip_pool_collection.

byoipRangeId String
displayName String

A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

filters List<Property Map>

Supporting Types

GetPublicIpPoolsFilter

Name string
Values List<string>
Regex bool
Name string
Values []string
Regex bool
name String
values List<String>
regex Boolean
name string
values string[]
regex boolean
name str
values Sequence[str]
regex bool
name String
values List<String>
regex Boolean

GetPublicIpPoolsPublicIpPoolCollection

GetPublicIpPoolsPublicIpPoolCollectionItem

CidrBlocks List<string>

The CIDR blocks added to this pool. This could be all or a portion of a BYOIP CIDR block.

CompartmentId string

The OCID of the compartment.

DefinedTags Dictionary<string, object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

A filter to return only resources that match the given display name exactly.

FreeformTags Dictionary<string, object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id string

The OCID of the public IP pool.

State string

The public IP pool's current state.

TimeCreated string

The date and time the public IP pool was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

CidrBlocks []string

The CIDR blocks added to this pool. This could be all or a portion of a BYOIP CIDR block.

CompartmentId string

The OCID of the compartment.

DefinedTags map[string]interface{}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

DisplayName string

A filter to return only resources that match the given display name exactly.

FreeformTags map[string]interface{}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

Id string

The OCID of the public IP pool.

State string

The public IP pool's current state.

TimeCreated string

The date and time the public IP pool was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

cidrBlocks List<String>

The CIDR blocks added to this pool. This could be all or a portion of a BYOIP CIDR block.

compartmentId String

The OCID of the compartment.

definedTags Map<String,Object>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

A filter to return only resources that match the given display name exactly.

freeformTags Map<String,Object>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id String

The OCID of the public IP pool.

state String

The public IP pool's current state.

timeCreated String

The date and time the public IP pool was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

cidrBlocks string[]

The CIDR blocks added to this pool. This could be all or a portion of a BYOIP CIDR block.

compartmentId string

The OCID of the compartment.

definedTags {[key: string]: any}

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName string

A filter to return only resources that match the given display name exactly.

freeformTags {[key: string]: any}

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id string

The OCID of the public IP pool.

state string

The public IP pool's current state.

timeCreated string

The date and time the public IP pool was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

cidr_blocks Sequence[str]

The CIDR blocks added to this pool. This could be all or a portion of a BYOIP CIDR block.

compartment_id str

The OCID of the compartment.

defined_tags Mapping[str, Any]

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

display_name str

A filter to return only resources that match the given display name exactly.

freeform_tags Mapping[str, Any]

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id str

The OCID of the public IP pool.

state str

The public IP pool's current state.

time_created str

The date and time the public IP pool was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

cidrBlocks List<String>

The CIDR blocks added to this pool. This could be all or a portion of a BYOIP CIDR block.

compartmentId String

The OCID of the compartment.

definedTags Map<Any>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

displayName String

A filter to return only resources that match the given display name exactly.

freeformTags Map<Any>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

id String

The OCID of the public IP pool.

state String

The public IP pool's current state.

timeCreated String

The date and time the public IP pool was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

Package Details

Repository
https://github.com/pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.