Oracle Cloud Infrastructure v2.31.0, Apr 17 25

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

oci.ResourceManager.getPrivateEndpoints

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.31.0 published on Thursday, Apr 17, 2025 by Pulumi

Example Usage

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

const testPrivateEndpoints = oci.ResourceManager.getPrivateEndpoints({
    compartmentId: compartmentId,
    displayName: privateEndpointDisplayName,
    privateEndpointId: testPrivateEndpoint.id,
    vcnId: testVcn.id,
});

import pulumi
import pulumi_oci as oci

test_private_endpoints = oci.ResourceManager.get_private_endpoints(compartment_id=compartment_id,
    display_name=private_endpoint_display_name,
    private_endpoint_id=test_private_endpoint["id"],
    vcn_id=test_vcn["id"])

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := resourcemanager.GetPrivateEndpoints(ctx, &resourcemanager.GetPrivateEndpointsArgs{
			CompartmentId:     pulumi.StringRef(compartmentId),
			DisplayName:       pulumi.StringRef(privateEndpointDisplayName),
			PrivateEndpointId: pulumi.StringRef(testPrivateEndpoint.Id),
			VcnId:             pulumi.StringRef(testVcn.Id),
		}, 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.ResourceManager.GetPrivateEndpoints.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = privateEndpointDisplayName,
        PrivateEndpointId = testPrivateEndpoint.Id,
        VcnId = testVcn.Id,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ResourceManager.ResourceManagerFunctions;
import com.pulumi.oci.ResourceManager.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 = ResourceManagerFunctions.getPrivateEndpoints(GetPrivateEndpointsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(privateEndpointDisplayName)
            .privateEndpointId(testPrivateEndpoint.id())
            .vcnId(testVcn.id())
            .build());

    }
}

variables:
  testPrivateEndpoints:
    fn::invoke:
      function: oci:ResourceManager:getPrivateEndpoints
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${privateEndpointDisplayName}
        privateEndpointId: ${testPrivateEndpoint.id}
        vcnId: ${testVcn.id}

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[_resourcemanager.GetPrivateEndpointsFilter]] = None,
                          private_endpoint_id: Optional[str] = None,
                          vcn_id: 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[_resourcemanager.GetPrivateEndpointsFilterArgs]]]] = None,
                          private_endpoint_id: Optional[pulumi.Input[str]] = None,
                          vcn_id: 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:ResourceManager/getPrivateEndpoints:getPrivateEndpoints
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: A filter to return only resources that exist in the compartment, identified by OCID.
DisplayName string: A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.
Filters List<GetPrivateEndpointsFilter>
PrivateEndpointId string: The OCID of the private endpoint.
VcnId string: The OCID of the VCN.

CompartmentId string: A filter to return only resources that exist in the compartment, identified by OCID.
DisplayName string: A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.
Filters []GetPrivateEndpointsFilter
PrivateEndpointId string: The OCID of the private endpoint.
VcnId string: The OCID of the VCN.

compartmentId String: A filter to return only resources that exist in the compartment, identified by OCID.
displayName String: A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.
filters List<GetPrivateEndpointsFilter>
privateEndpointId String: The OCID of the private endpoint.
vcnId String: The OCID of the VCN.

compartmentId string: A filter to return only resources that exist in the compartment, identified by OCID.
displayName string: A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.
filters GetPrivateEndpointsFilter[]
privateEndpointId string: The OCID of the private endpoint.
vcnId string: The OCID of the VCN.

compartment_id str: A filter to return only resources that exist in the compartment, identified by OCID.
display_name str: A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.
filters Sequence[resourcemanager.GetPrivateEndpointsFilter]
private_endpoint_id str: The OCID of the private endpoint.
vcn_id str: The OCID of the VCN.

compartmentId String: A filter to return only resources that exist in the compartment, identified by OCID.
displayName String: A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.
filters List<Property Map>
privateEndpointId String: The OCID of the private endpoint.
vcnId String: The OCID of the VCN.

getPrivateEndpoints Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
PrivateEndpointCollections List<GetPrivateEndpointsPrivateEndpointCollection>: The list of private_endpoint_collection.
CompartmentId string: The OCID of the compartment containing this private endpoint details.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Filters List<GetPrivateEndpointsFilter>
PrivateEndpointId string
VcnId string: The OCID of the VCN for the private endpoint.

Id string: The provider-assigned unique ID for this managed resource.
PrivateEndpointCollections []GetPrivateEndpointsPrivateEndpointCollection: The list of private_endpoint_collection.
CompartmentId string: The OCID of the compartment containing this private endpoint details.
DisplayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Filters []GetPrivateEndpointsFilter
PrivateEndpointId string
VcnId string: The OCID of the VCN for the private endpoint.

id String: The provider-assigned unique ID for this managed resource.
privateEndpointCollections List<GetPrivateEndpointsPrivateEndpointCollection>: The list of private_endpoint_collection.
compartmentId String: The OCID of the compartment containing this private endpoint details.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters List<GetPrivateEndpointsFilter>
privateEndpointId String
vcnId String: The OCID of the VCN for the private endpoint.

id string: The provider-assigned unique ID for this managed resource.
privateEndpointCollections GetPrivateEndpointsPrivateEndpointCollection[]: The list of private_endpoint_collection.
compartmentId string: The OCID of the compartment containing this private endpoint details.
displayName string: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters GetPrivateEndpointsFilter[]
privateEndpointId string
vcnId string: The OCID of the VCN for the private endpoint.

id str: The provider-assigned unique ID for this managed resource.
private_endpoint_collections Sequence[resourcemanager.GetPrivateEndpointsPrivateEndpointCollection]: The list of private_endpoint_collection.
compartment_id str: The OCID of the compartment containing this private endpoint details.
display_name str: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters Sequence[resourcemanager.GetPrivateEndpointsFilter]
private_endpoint_id str
vcn_id str: The OCID of the VCN for the private endpoint.

id String: The provider-assigned unique ID for this managed resource.
privateEndpointCollections List<Property Map>: The list of private_endpoint_collection.
compartmentId String: The OCID of the compartment containing this private endpoint details.
displayName String: A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
filters List<Property Map>
privateEndpointId String
vcnId String: The OCID of the VCN for the 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

Items List<GetPrivateEndpointsPrivateEndpointCollectionItem>

Items []GetPrivateEndpointsPrivateEndpointCollectionItem

items List<GetPrivateEndpointsPrivateEndpointCollectionItem>

items GetPrivateEndpointsPrivateEndpointCollectionItem[]

items Sequence[resourcemanager.GetPrivateEndpointsPrivateEndpointCollectionItem]

items List<Property Map>

GetPrivateEndpointsPrivateEndpointCollectionItem

CompartmentId string: A filter to return only resources that exist in the compartment, identified by OCID.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: Description of the private endpoint. Avoid entering confidential information.
DisplayName string: A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.
DnsZones List<string>: DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
FreeformTags Dictionary<string, string>: Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: Unique identifier (OCID) of the private endpoint details.
IsUsedWithConfigurationSourceProvider bool: When true, allows the private endpoint to be used with a configuration source provider.
NsgIdLists List<string>: An array of network security groups (NSG) that the customer can optionally provide.
SourceIps List<string>: The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
State string: The current lifecycle state of the private endpoint.
SubnetId string: The OCID of the subnet within the VCN for the private endpoint.
TimeCreated string: The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
VcnId string: The OCID of the VCN.

CompartmentId string: A filter to return only resources that exist in the compartment, identified by OCID.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: Description of the private endpoint. Avoid entering confidential information.
DisplayName string: A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.
DnsZones []string: DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
FreeformTags map[string]string: Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
Id string: Unique identifier (OCID) of the private endpoint details.
IsUsedWithConfigurationSourceProvider bool: When true, allows the private endpoint to be used with a configuration source provider.
NsgIdLists []string: An array of network security groups (NSG) that the customer can optionally provide.
SourceIps []string: The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
State string: The current lifecycle state of the private endpoint.
SubnetId string: The OCID of the subnet within the VCN for the private endpoint.
TimeCreated string: The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
VcnId string: The OCID of the VCN.

compartmentId String: A filter to return only resources that exist in the compartment, identified by OCID.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: Description of the private endpoint. Avoid entering confidential information.
displayName String: A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.
dnsZones List<String>: DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
freeformTags Map<String,String>: Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: Unique identifier (OCID) of the private endpoint details.
isUsedWithConfigurationSourceProvider Boolean: When true, allows the private endpoint to be used with a configuration source provider.
nsgIdLists List<String>: An array of network security groups (NSG) that the customer can optionally provide.
sourceIps List<String>: The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
state String: The current lifecycle state of the private endpoint.
subnetId String: The OCID of the subnet within the VCN for the private endpoint.
timeCreated String: The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
vcnId String: The OCID of the VCN.

compartmentId string: A filter to return only resources that exist in the compartment, identified by OCID.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description string: Description of the private endpoint. Avoid entering confidential information.
displayName string: A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.
dnsZones string[]: DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
freeformTags {[key: string]: string}: Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id string: Unique identifier (OCID) of the private endpoint details.
isUsedWithConfigurationSourceProvider boolean: When true, allows the private endpoint to be used with a configuration source provider.
nsgIdLists string[]: An array of network security groups (NSG) that the customer can optionally provide.
sourceIps string[]: The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
state string: The current lifecycle state of the private endpoint.
subnetId string: The OCID of the subnet within the VCN for the private endpoint.
timeCreated string: The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
vcnId string: The OCID of the VCN.

compartment_id str: A filter to return only resources that exist in the compartment, identified by OCID.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description str: Description of the private endpoint. Avoid entering confidential information.
display_name str: A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.
dns_zones Sequence[str]: DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
freeform_tags Mapping[str, str]: Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id str: Unique identifier (OCID) of the private endpoint details.
is_used_with_configuration_source_provider bool: When true, allows the private endpoint to be used with a configuration source provider.
nsg_id_lists Sequence[str]: An array of network security groups (NSG) that the customer can optionally provide.
source_ips Sequence[str]: The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
state str: The current lifecycle state of the private endpoint.
subnet_id str: The OCID of the subnet within the VCN for the private endpoint.
time_created str: The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
vcn_id str: The OCID of the VCN.

compartmentId String: A filter to return only resources that exist in the compartment, identified by OCID.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: Description of the private endpoint. Avoid entering confidential information.
displayName String: A filter to return only resources that match the given display name exactly. Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.
dnsZones List<String>: DNS Proxy forwards any DNS FQDN queries over into the consumer DNS resolver if the DNS FQDN is included in the dns zones list otherwise it goes to service provider VCN resolver.
freeformTags Map<String>: Free-form tags associated with the resource. Each tag is a key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
id String: Unique identifier (OCID) of the private endpoint details.
isUsedWithConfigurationSourceProvider Boolean: When true, allows the private endpoint to be used with a configuration source provider.
nsgIdLists List<String>: An array of network security groups (NSG) that the customer can optionally provide.
sourceIps List<String>: The source IPs which resource manager service will use to connect to customer's network. Automatically assigned by Resource Manager Service.
state String: The current lifecycle state of the private endpoint.
subnetId String: The OCID of the subnet within the VCN for the private endpoint.
timeCreated String: The date and time at which the private endpoint was created. Format is defined by RFC3339. Example: 2020-11-25T21:10:29.600Z
vcnId String: The OCID of the VCN.

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.31.0 published on Thursday, Apr 17, 2025 by Pulumi

pulumi/pulumi-oci

oci.ResourceManager.getPrivateEndpoints

On this page

On this page

Example Usage

Using getPrivateEndpoints

getPrivateEndpoints Result

Supporting Types

GetPrivateEndpointsFilter

GetPrivateEndpointsPrivateEndpointCollection

GetPrivateEndpointsPrivateEndpointCollectionItem

Package Details

On this page

On this page