1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GloballyDistributedDatabase
  5. getPrivateEndpoints
Oracle Cloud Infrastructure v3.11.1 published on Friday, Nov 14, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

oci.GloballyDistributedDatabase.getPrivateEndpoints

oci logo
Oracle Cloud Infrastructure v3.11.1 published on Friday, Nov 14, 2025 by Pulumi
Schema (JSON)
pulumi/pulumi-oci

    This data source provides the list of Private Endpoints in Oracle Cloud Infrastructure Globally Distributed Database service.

    List of PrivateEndpoints.

    Example Usage

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

const testPrivateEndpoints = oci.GloballyDistributedDatabase.getPrivateEndpoints({
    compartmentId: compartmentId,
    displayName: privateEndpointDisplayName,
    state: privateEndpointState,
});

    import pulumi
import pulumi_oci as oci

test_private_endpoints = oci.GloballyDistributedDatabase.get_private_endpoints(compartment_id=compartment_id,
    display_name=private_endpoint_display_name,
    state=private_endpoint_state)

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := globallydistributeddatabase.GetPrivateEndpoints(ctx, &globallydistributeddatabase.GetPrivateEndpointsArgs{
			CompartmentId: compartmentId,
			DisplayName:   pulumi.StringRef(privateEndpointDisplayName),
			State:         pulumi.StringRef(privateEndpointState),
		}, 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 testPrivateEndpoints = Oci.GloballyDistributedDatabase.GetPrivateEndpoints.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = privateEndpointDisplayName,
        State = privateEndpointState,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.GloballyDistributedDatabase.GloballyDistributedDatabaseFunctions;
import com.pulumi.oci.GloballyDistributedDatabase.inputs.GetPrivateEndpointsArgs;
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 testPrivateEndpoints = GloballyDistributedDatabaseFunctions.getPrivateEndpoints(GetPrivateEndpointsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(privateEndpointDisplayName)
            .state(privateEndpointState)
            .build());

    }
}

    variables:
  testPrivateEndpoints:
    fn::invoke:
      function: oci:GloballyDistributedDatabase:getPrivateEndpoints
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${privateEndpointDisplayName}
        state: ${privateEndpointState}

    Using getPrivateEndpoints

    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 getPrivateEndpoints(args: GetPrivateEndpointsArgs, opts?: InvokeOptions): Promise<GetPrivateEndpointsResult>
function getPrivateEndpointsOutput(args: GetPrivateEndpointsOutputArgs, opts?: InvokeOptions): Output<GetPrivateEndpointsResult>
    def get_private_endpoints(compartment_id: Optional[str] = None,
                          display_name: Optional[str] = None,
                          filters: Optional[Sequence[GetPrivateEndpointsFilter]] = None,
                          state: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointsResult
def get_private_endpoints_output(compartment_id: Optional[pulumi.Input[str]] = None,
                          display_name: Optional[pulumi.Input[str]] = None,
                          filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetPrivateEndpointsFilterArgs]]]] = None,
                          state: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetPrivateEndpointsResult]
    func GetPrivateEndpoints(ctx *Context, args *GetPrivateEndpointsArgs, opts ...InvokeOption) (*GetPrivateEndpointsResult, error)
func GetPrivateEndpointsOutput(ctx *Context, args *GetPrivateEndpointsOutputArgs, opts ...InvokeOption) GetPrivateEndpointsResultOutput

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

    public static class GetPrivateEndpoints 
{
    public static Task<GetPrivateEndpointsResult> InvokeAsync(GetPrivateEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateEndpointsResult> Invoke(GetPrivateEndpointsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPrivateEndpointsResult> getPrivateEndpoints(GetPrivateEndpointsArgs args, InvokeOptions options)
public static Output<GetPrivateEndpointsResult> getPrivateEndpoints(GetPrivateEndpointsArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:GloballyDistributedDatabase/getPrivateEndpoints:getPrivateEndpoints
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The ID of the compartment in which to list resources.
    DisplayName string
    A filter to return only private endpoint that match the entire name given. The match is not case sensitive.
    Filters List<GetPrivateEndpointsFilter>
    State string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    CompartmentId string
    The ID of the compartment in which to list resources.
    DisplayName string
    A filter to return only private endpoint that match the entire name given. The match is not case sensitive.
    Filters []GetPrivateEndpointsFilter
    State string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    compartmentId String
    The ID of the compartment in which to list resources.
    displayName String
    A filter to return only private endpoint that match the entire name given. The match is not case sensitive.
    filters List<GetPrivateEndpointsFilter>
    state String
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    compartmentId string
    The ID of the compartment in which to list resources.
    displayName string
    A filter to return only private endpoint that match the entire name given. The match is not case sensitive.
    filters GetPrivateEndpointsFilter[]
    state string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    compartment_id str
    The ID of the compartment in which to list resources.
    display_name str
    A filter to return only private endpoint that match the entire name given. The match is not case sensitive.
    filters Sequence[GetPrivateEndpointsFilter]
    state str
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    compartmentId String
    The ID of the compartment in which to list resources.
    displayName String
    A filter to return only private endpoint that match the entire name given. The match is not case sensitive.
    filters List<Property Map>
    state String
    A filter to return only resources their lifecycleState matches the given lifecycleState.

    getPrivateEndpoints Result

    The following output properties are available:

    CompartmentId string
    Identifier of the compartment in which private endpoint exists.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateEndpointCollections List<GetPrivateEndpointsPrivateEndpointCollection>
    The list of private_endpoint_collection.
    DisplayName string
    PrivateEndpoint display name.
    Filters List<GetPrivateEndpointsFilter>
    State string
    Lifecycle states for private endpoint.
    CompartmentId string
    Identifier of the compartment in which private endpoint exists.
    Id string
    The provider-assigned unique ID for this managed resource.
    PrivateEndpointCollections []GetPrivateEndpointsPrivateEndpointCollection
    The list of private_endpoint_collection.
    DisplayName string
    PrivateEndpoint display name.
    Filters []GetPrivateEndpointsFilter
    State string
    Lifecycle states for private endpoint.
    compartmentId String
    Identifier of the compartment in which private endpoint exists.
    id String
    The provider-assigned unique ID for this managed resource.
    privateEndpointCollections List<GetPrivateEndpointsPrivateEndpointCollection>
    The list of private_endpoint_collection.
    displayName String
    PrivateEndpoint display name.
    filters List<GetPrivateEndpointsFilter>
    state String
    Lifecycle states for private endpoint.
    compartmentId string
    Identifier of the compartment in which private endpoint exists.
    id string
    The provider-assigned unique ID for this managed resource.
    privateEndpointCollections GetPrivateEndpointsPrivateEndpointCollection[]
    The list of private_endpoint_collection.
    displayName string
    PrivateEndpoint display name.
    filters GetPrivateEndpointsFilter[]
    state string
    Lifecycle states for private endpoint.
    compartment_id str
    Identifier of the compartment in which private endpoint exists.
    id str
    The provider-assigned unique ID for this managed resource.
    private_endpoint_collections Sequence[GetPrivateEndpointsPrivateEndpointCollection]
    The list of private_endpoint_collection.
    display_name str
    PrivateEndpoint display name.
    filters Sequence[GetPrivateEndpointsFilter]
    state str
    Lifecycle states for private endpoint.
    compartmentId String
    Identifier of the compartment in which private endpoint exists.
    id String
    The provider-assigned unique ID for this managed resource.
    privateEndpointCollections List<Property Map>
    The list of private_endpoint_collection.
    displayName String
    PrivateEndpoint display name.
    filters List<Property Map>
    state String
    Lifecycle states for private endpoint.

    Supporting Types

    GetPrivateEndpointsFilter

    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

    GetPrivateEndpointsPrivateEndpointCollection

    GetPrivateEndpointsPrivateEndpointCollectionItem

    CompartmentId string
    The ID of the compartment in which to list resources.
    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
    PrivateEndpoint description.
    DisplayName string
    A filter to return only private endpoint that match the entire name given. The match is not case sensitive.
    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 identifier of the Private Endpoint.
    LifecycleStateDetails string
    Detailed message for the lifecycle state.
    NsgIds List<string>
    The OCIDs of the network security groups that the private endpoint belongs to.
    PrivateIp string
    IP address of the Private Endpoint.
    ProxyComputeInstanceId string
    The identifier of the proxy compute instance.
    ReinstateProxyInstanceTrigger int
    ShardedDatabases List<string>
    The OCIDs of sharded databases that consumes the given private endpoint.
    State string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    SubnetId string
    Identifier of the subnet in which private endpoint exists.
    SystemTags Dictionary<string, string>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the PrivateEndpoint was first created. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
    VcnId string
    Identifier of the VCN in which subnet exists.
    CompartmentId string
    The ID of the compartment in which to list resources.
    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
    PrivateEndpoint description.
    DisplayName string
    A filter to return only private endpoint that match the entire name given. The match is not case sensitive.
    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 identifier of the Private Endpoint.
    LifecycleStateDetails string
    Detailed message for the lifecycle state.
    NsgIds []string
    The OCIDs of the network security groups that the private endpoint belongs to.
    PrivateIp string
    IP address of the Private Endpoint.
    ProxyComputeInstanceId string
    The identifier of the proxy compute instance.
    ReinstateProxyInstanceTrigger int
    ShardedDatabases []string
    The OCIDs of sharded databases that consumes the given private endpoint.
    State string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    SubnetId string
    Identifier of the subnet in which private endpoint exists.
    SystemTags map[string]string
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The time the PrivateEndpoint was first created. An RFC3339 formatted datetime string
    TimeUpdated string
    The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
    VcnId string
    Identifier of the VCN in which subnet exists.
    compartmentId String
    The ID of the compartment in which to list resources.
    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
    PrivateEndpoint description.
    displayName String
    A filter to return only private endpoint that match the entire name given. The match is not case sensitive.
    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 identifier of the Private Endpoint.
    lifecycleStateDetails String
    Detailed message for the lifecycle state.
    nsgIds List<String>
    The OCIDs of the network security groups that the private endpoint belongs to.
    privateIp String
    IP address of the Private Endpoint.
    proxyComputeInstanceId String
    The identifier of the proxy compute instance.
    reinstateProxyInstanceTrigger Integer
    shardedDatabases List<String>
    The OCIDs of sharded databases that consumes the given private endpoint.
    state String
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    subnetId String
    Identifier of the subnet in which private endpoint exists.
    systemTags Map<String,String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the PrivateEndpoint was first created. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
    vcnId String
    Identifier of the VCN in which subnet exists.
    compartmentId string
    The ID of the compartment in which to list resources.
    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
    PrivateEndpoint description.
    displayName string
    A filter to return only private endpoint that match the entire name given. The match is not case sensitive.
    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 identifier of the Private Endpoint.
    lifecycleStateDetails string
    Detailed message for the lifecycle state.
    nsgIds string[]
    The OCIDs of the network security groups that the private endpoint belongs to.
    privateIp string
    IP address of the Private Endpoint.
    proxyComputeInstanceId string
    The identifier of the proxy compute instance.
    reinstateProxyInstanceTrigger number
    shardedDatabases string[]
    The OCIDs of sharded databases that consumes the given private endpoint.
    state string
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    subnetId string
    Identifier of the subnet in which private endpoint exists.
    systemTags {[key: string]: string}
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The time the PrivateEndpoint was first created. An RFC3339 formatted datetime string
    timeUpdated string
    The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
    vcnId string
    Identifier of the VCN in which subnet exists.
    compartment_id str
    The ID of the compartment in which to list resources.
    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
    PrivateEndpoint description.
    display_name str
    A filter to return only private endpoint that match the entire name given. The match is not case sensitive.
    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 identifier of the Private Endpoint.
    lifecycle_state_details str
    Detailed message for the lifecycle state.
    nsg_ids Sequence[str]
    The OCIDs of the network security groups that the private endpoint belongs to.
    private_ip str
    IP address of the Private Endpoint.
    proxy_compute_instance_id str
    The identifier of the proxy compute instance.
    reinstate_proxy_instance_trigger int
    sharded_databases Sequence[str]
    The OCIDs of sharded databases that consumes the given private endpoint.
    state str
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    subnet_id str
    Identifier of the subnet in which private endpoint exists.
    system_tags Mapping[str, str]
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The time the PrivateEndpoint was first created. An RFC3339 formatted datetime string
    time_updated str
    The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
    vcn_id str
    Identifier of the VCN in which subnet exists.
    compartmentId String
    The ID of the compartment in which to list resources.
    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
    PrivateEndpoint description.
    displayName String
    A filter to return only private endpoint that match the entire name given. The match is not case sensitive.
    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 identifier of the Private Endpoint.
    lifecycleStateDetails String
    Detailed message for the lifecycle state.
    nsgIds List<String>
    The OCIDs of the network security groups that the private endpoint belongs to.
    privateIp String
    IP address of the Private Endpoint.
    proxyComputeInstanceId String
    The identifier of the proxy compute instance.
    reinstateProxyInstanceTrigger Number
    shardedDatabases List<String>
    The OCIDs of sharded databases that consumes the given private endpoint.
    state String
    A filter to return only resources their lifecycleState matches the given lifecycleState.
    subnetId String
    Identifier of the subnet in which private endpoint exists.
    systemTags Map<String>
    Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The time the PrivateEndpoint was first created. An RFC3339 formatted datetime string
    timeUpdated String
    The time the Private Endpoint was last updated. An RFC3339 formatted datetime string
    vcnId String
    Identifier of the VCN in which subnet exists.

    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 v3.11.1 published on Friday, Nov 14, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-oci
      Meet Neo: Your AI Platform Teammate