Oracle Cloud Infrastructure v3.10.0, Nov 5 25

Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

oci.DataCatalog.getCatalogPrivateEndpoints

Start a Neo task

Explain and create an oci.DataCatalog.getCatalogPrivateEndpoints resource

Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

pulumi/pulumi-oci

Example Usage

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

const testCatalogPrivateEndpoints = oci.DataCatalog.getCatalogPrivateEndpoints({
    compartmentId: compartmentId,
    displayName: catalogPrivateEndpointDisplayName,
    state: catalogPrivateEndpointState,
});

import pulumi
import pulumi_oci as oci

test_catalog_private_endpoints = oci.DataCatalog.get_catalog_private_endpoints(compartment_id=compartment_id,
    display_name=catalog_private_endpoint_display_name,
    state=catalog_private_endpoint_state)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datacatalog.GetCatalogPrivateEndpoints(ctx, &datacatalog.GetCatalogPrivateEndpointsArgs{
			CompartmentId: compartmentId,
			DisplayName:   pulumi.StringRef(catalogPrivateEndpointDisplayName),
			State:         pulumi.StringRef(catalogPrivateEndpointState),
		}, 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 testCatalogPrivateEndpoints = Oci.DataCatalog.GetCatalogPrivateEndpoints.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = catalogPrivateEndpointDisplayName,
        State = catalogPrivateEndpointState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataCatalog.DataCatalogFunctions;
import com.pulumi.oci.DataCatalog.inputs.GetCatalogPrivateEndpointsArgs;
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 testCatalogPrivateEndpoints = DataCatalogFunctions.getCatalogPrivateEndpoints(GetCatalogPrivateEndpointsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(catalogPrivateEndpointDisplayName)
            .state(catalogPrivateEndpointState)
            .build());

    }
}

variables:
  testCatalogPrivateEndpoints:
    fn::invoke:
      function: oci:DataCatalog:getCatalogPrivateEndpoints
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${catalogPrivateEndpointDisplayName}
        state: ${catalogPrivateEndpointState}

Using getCatalogPrivateEndpoints

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 getCatalogPrivateEndpoints(args: GetCatalogPrivateEndpointsArgs, opts?: InvokeOptions): Promise<GetCatalogPrivateEndpointsResult>
function getCatalogPrivateEndpointsOutput(args: GetCatalogPrivateEndpointsOutputArgs, opts?: InvokeOptions): Output<GetCatalogPrivateEndpointsResult>

def get_catalog_private_endpoints(compartment_id: Optional[str] = None,
                                  display_name: Optional[str] = None,
                                  filters: Optional[Sequence[GetCatalogPrivateEndpointsFilter]] = None,
                                  state: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetCatalogPrivateEndpointsResult
def get_catalog_private_endpoints_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                  display_name: Optional[pulumi.Input[str]] = None,
                                  filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetCatalogPrivateEndpointsFilterArgs]]]] = None,
                                  state: Optional[pulumi.Input[str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetCatalogPrivateEndpointsResult]

func GetCatalogPrivateEndpoints(ctx *Context, args *GetCatalogPrivateEndpointsArgs, opts ...InvokeOption) (*GetCatalogPrivateEndpointsResult, error)
func GetCatalogPrivateEndpointsOutput(ctx *Context, args *GetCatalogPrivateEndpointsOutputArgs, opts ...InvokeOption) GetCatalogPrivateEndpointsResultOutput

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

public static class GetCatalogPrivateEndpoints 
{
    public static Task<GetCatalogPrivateEndpointsResult> InvokeAsync(GetCatalogPrivateEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetCatalogPrivateEndpointsResult> Invoke(GetCatalogPrivateEndpointsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetCatalogPrivateEndpointsResult> getCatalogPrivateEndpoints(GetCatalogPrivateEndpointsArgs args, InvokeOptions options)
public static Output<GetCatalogPrivateEndpointsResult> getCatalogPrivateEndpoints(GetCatalogPrivateEndpointsArgs args, InvokeOptions options)

fn::invoke:
  function: oci:DataCatalog/getCatalogPrivateEndpoints:getCatalogPrivateEndpoints
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The OCID of the compartment where you want to list resources.
DisplayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
Filters List<GetCatalogPrivateEndpointsFilter>
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

CompartmentId string: The OCID of the compartment where you want to list resources.
DisplayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
Filters []GetCatalogPrivateEndpointsFilter
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

compartmentId String: The OCID of the compartment where you want to list resources.
displayName String: A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters List<GetCatalogPrivateEndpointsFilter>
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

compartmentId string: The OCID of the compartment where you want to list resources.
displayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters GetCatalogPrivateEndpointsFilter[]
state string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

compartment_id str: The OCID of the compartment where you want to list resources.
display_name str: A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters Sequence[GetCatalogPrivateEndpointsFilter]
state str: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

compartmentId String: The OCID of the compartment where you want to list resources.
displayName String: A filter to return only resources that match the entire display name given. The match is not case sensitive.
filters List<Property Map>
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

getCatalogPrivateEndpoints Result

The following output properties are available:

CatalogPrivateEndpoints List<GetCatalogPrivateEndpointsCatalogPrivateEndpoint>: The list of catalog_private_endpoints.
CompartmentId string: Identifier of the compartment this private endpoint belongs to
Id string: The provider-assigned unique ID for this managed resource.
DisplayName string: Mutable name of the Private Reverse Connection Endpoint
Filters List<GetCatalogPrivateEndpointsFilter>
State string: The current state of the private endpoint resource.

CatalogPrivateEndpoints []GetCatalogPrivateEndpointsCatalogPrivateEndpoint: The list of catalog_private_endpoints.
CompartmentId string: Identifier of the compartment this private endpoint belongs to
Id string: The provider-assigned unique ID for this managed resource.
DisplayName string: Mutable name of the Private Reverse Connection Endpoint
Filters []GetCatalogPrivateEndpointsFilter
State string: The current state of the private endpoint resource.

catalogPrivateEndpoints List<GetCatalogPrivateEndpointsCatalogPrivateEndpoint>: The list of catalog_private_endpoints.
compartmentId String: Identifier of the compartment this private endpoint belongs to
id String: The provider-assigned unique ID for this managed resource.
displayName String: Mutable name of the Private Reverse Connection Endpoint
filters List<GetCatalogPrivateEndpointsFilter>
state String: The current state of the private endpoint resource.

catalogPrivateEndpoints GetCatalogPrivateEndpointsCatalogPrivateEndpoint[]: The list of catalog_private_endpoints.
compartmentId string: Identifier of the compartment this private endpoint belongs to
id string: The provider-assigned unique ID for this managed resource.
displayName string: Mutable name of the Private Reverse Connection Endpoint
filters GetCatalogPrivateEndpointsFilter[]
state string: The current state of the private endpoint resource.

catalog_private_endpoints Sequence[GetCatalogPrivateEndpointsCatalogPrivateEndpoint]: The list of catalog_private_endpoints.
compartment_id str: Identifier of the compartment this private endpoint belongs to
id str: The provider-assigned unique ID for this managed resource.
display_name str: Mutable name of the Private Reverse Connection Endpoint
filters Sequence[GetCatalogPrivateEndpointsFilter]
state str: The current state of the private endpoint resource.

catalogPrivateEndpoints List<Property Map>: The list of catalog_private_endpoints.
compartmentId String: Identifier of the compartment this private endpoint belongs to
id String: The provider-assigned unique ID for this managed resource.
displayName String: Mutable name of the Private Reverse Connection Endpoint
filters List<Property Map>
state String: The current state of the private endpoint resource.

Supporting Types

GetCatalogPrivateEndpointsCatalogPrivateEndpoint

AttachedCatalogs List<string>: The list of catalogs using the private reverse connection endpoint
CompartmentId string: The OCID of the compartment where you want to list resources.
DefinedTags Dictionary<string, string>: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
DnsZones List<string>: List of DNS zones to be used by the data assets to be harvested. Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com
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: Unique identifier that is immutable
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
Locks List<GetCatalogPrivateEndpointsCatalogPrivateEndpointLock>: Locks associated with this resource.
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
SubnetId string: Subnet Identifier
SystemTags Dictionary<string, string>: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time the private endpoint was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time the private endpoint was updated. An RFC3339 formatted datetime string.

AttachedCatalogs []string: The list of catalogs using the private reverse connection endpoint
CompartmentId string: The OCID of the compartment where you want to list resources.
DefinedTags map[string]string: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
DisplayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
DnsZones []string: List of DNS zones to be used by the data assets to be harvested. Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com
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: Unique identifier that is immutable
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
Locks []GetCatalogPrivateEndpointsCatalogPrivateEndpointLock: Locks associated with this resource.
State string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
SubnetId string: Subnet Identifier
SystemTags map[string]string: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The time the private endpoint was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time the private endpoint was updated. An RFC3339 formatted datetime string.

attachedCatalogs List<String>: The list of catalogs using the private reverse connection endpoint
compartmentId String: The OCID of the compartment where you want to list resources.
definedTags Map<String,String>: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
displayName String: A filter to return only resources that match the entire display name given. The match is not case sensitive.
dnsZones List<String>: List of DNS zones to be used by the data assets to be harvested. Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com
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: Unique identifier that is immutable
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
locks List<GetCatalogPrivateEndpointsCatalogPrivateEndpointLock>: Locks associated with this resource.
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
subnetId String: Subnet Identifier
systemTags Map<String,String>: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time the private endpoint was created. An RFC3339 formatted datetime string.
timeUpdated String: The time the private endpoint was updated. An RFC3339 formatted datetime string.

attachedCatalogs string[]: The list of catalogs using the private reverse connection endpoint
compartmentId string: The OCID of the compartment where you want to list resources.
definedTags {[key: string]: string}: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
displayName string: A filter to return only resources that match the entire display name given. The match is not case sensitive.
dnsZones string[]: List of DNS zones to be used by the data assets to be harvested. Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com
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: Unique identifier that is immutable
lifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
locks GetCatalogPrivateEndpointsCatalogPrivateEndpointLock[]: Locks associated with this resource.
state string: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
subnetId string: Subnet Identifier
systemTags {[key: string]: string}: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: The time the private endpoint was created. An RFC3339 formatted datetime string.
timeUpdated string: The time the private endpoint was updated. An RFC3339 formatted datetime string.

attached_catalogs Sequence[str]: The list of catalogs using the private reverse connection endpoint
compartment_id str: The OCID of the compartment where you want to list resources.
defined_tags Mapping[str, str]: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
display_name str: A filter to return only resources that match the entire display name given. The match is not case sensitive.
dns_zones Sequence[str]: List of DNS zones to be used by the data assets to be harvested. Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com
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: Unique identifier that is immutable
lifecycle_details str: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
locks Sequence[GetCatalogPrivateEndpointsCatalogPrivateEndpointLock]: Locks associated with this resource.
state str: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
subnet_id str: Subnet Identifier
system_tags Mapping[str, str]: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str: The time the private endpoint was created. An RFC3339 formatted datetime string.
time_updated str: The time the private endpoint was updated. An RFC3339 formatted datetime string.

attachedCatalogs List<String>: The list of catalogs using the private reverse connection endpoint
compartmentId String: The OCID of the compartment where you want to list resources.
definedTags Map<String>: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"foo-namespace.bar-key": "value"}
displayName String: A filter to return only resources that match the entire display name given. The match is not case sensitive.
dnsZones List<String>: List of DNS zones to be used by the data assets to be harvested. Example: custpvtsubnet.oraclevcn.com for data asset: db.custpvtsubnet.oraclevcn.com
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: Unique identifier that is immutable
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in 'Failed' state.
locks List<Property Map>: Locks associated with this resource.
state String: A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
subnetId String: Subnet Identifier
systemTags Map<String>: System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The time the private endpoint was created. An RFC3339 formatted datetime string.
timeUpdated String: The time the private endpoint was updated. An RFC3339 formatted datetime string.

GetCatalogPrivateEndpointsCatalogPrivateEndpointLock

Message string: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
RelatedResourceId string: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated string: The time the private endpoint was created. An RFC3339 formatted datetime string.
Type string: Type of the lock.

Message string: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
RelatedResourceId string: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
TimeCreated string: The time the private endpoint was created. An RFC3339 formatted datetime string.
Type string: Type of the lock.

message String: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId String: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated String: The time the private endpoint was created. An RFC3339 formatted datetime string.
type String: Type of the lock.

message string: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId string: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated string: The time the private endpoint was created. An RFC3339 formatted datetime string.
type string: Type of the lock.

message str: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
related_resource_id str: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
time_created str: The time the private endpoint was created. An RFC3339 formatted datetime string.
type str: Type of the lock.

message String: A message added by the creator of the lock. This is typically used to give an indication of why the resource is locked.
relatedResourceId String: The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.
timeCreated String: The time the private endpoint was created. An RFC3339 formatted datetime string.
type String: Type of the lock.

GetCatalogPrivateEndpointsFilter

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

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 v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

pulumi/pulumi-oci

oci.DataCatalog.getCatalogPrivateEndpoints

On this page

On this page

Example Usage

Using getCatalogPrivateEndpoints

getCatalogPrivateEndpoints Result

Supporting Types

GetCatalogPrivateEndpointsCatalogPrivateEndpoint

GetCatalogPrivateEndpointsCatalogPrivateEndpointLock

GetCatalogPrivateEndpointsFilter

Package Details

On this page

On this page