1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. ResourceManager
  5. getPrivateEndpoint
Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi
pulumi/pulumi-oci

oci.ResourceManager.getPrivateEndpoint

Start a Neo task
Explain and create an oci.ResourceManager.getPrivateEndpoint resource
oci logo
Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi
pulumi/pulumi-oci

    This data source provides details about a specific Private Endpoint resource in Oracle Cloud Infrastructure Resource Manager service.

    Gets the specified private endpoint. For more information, see Getting a Private Endpoint’s Details.

    Example Usage

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

const testPrivateEndpoint = oci.ResourceManager.getPrivateEndpoint({
    privateEndpointId: testPrivateEndpointOciResourcemanagerPrivateEndpoint.id,
});

    import pulumi
import pulumi_oci as oci

test_private_endpoint = oci.ResourceManager.get_private_endpoint(private_endpoint_id=test_private_endpoint_oci_resourcemanager_private_endpoint["id"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := resourcemanager.GetPrivateEndpoint(ctx, &resourcemanager.GetPrivateEndpointArgs{
			PrivateEndpointId: testPrivateEndpointOciResourcemanagerPrivateEndpoint.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 testPrivateEndpoint = Oci.ResourceManager.GetPrivateEndpoint.Invoke(new()
    {
        PrivateEndpointId = testPrivateEndpointOciResourcemanagerPrivateEndpoint.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.GetPrivateEndpointArgs;
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 testPrivateEndpoint = ResourceManagerFunctions.getPrivateEndpoint(GetPrivateEndpointArgs.builder()
            .privateEndpointId(testPrivateEndpointOciResourcemanagerPrivateEndpoint.id())
            .build());

    }
}

    variables:
  testPrivateEndpoint:
    fn::invoke:
      function: oci:ResourceManager:getPrivateEndpoint
      arguments:
        privateEndpointId: ${testPrivateEndpointOciResourcemanagerPrivateEndpoint.id}

    Using getPrivateEndpoint

    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 getPrivateEndpoint(args: GetPrivateEndpointArgs, opts?: InvokeOptions): Promise<GetPrivateEndpointResult>
function getPrivateEndpointOutput(args: GetPrivateEndpointOutputArgs, opts?: InvokeOptions): Output<GetPrivateEndpointResult>
    def get_private_endpoint(private_endpoint_id: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointResult
def get_private_endpoint_output(private_endpoint_id: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetPrivateEndpointResult]
    func LookupPrivateEndpoint(ctx *Context, args *LookupPrivateEndpointArgs, opts ...InvokeOption) (*LookupPrivateEndpointResult, error)
func LookupPrivateEndpointOutput(ctx *Context, args *LookupPrivateEndpointOutputArgs, opts ...InvokeOption) LookupPrivateEndpointResultOutput

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

    public static class GetPrivateEndpoint 
{
    public static Task<GetPrivateEndpointResult> InvokeAsync(GetPrivateEndpointArgs args, InvokeOptions? opts = null)
    public static Output<GetPrivateEndpointResult> Invoke(GetPrivateEndpointInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetPrivateEndpointResult> getPrivateEndpoint(GetPrivateEndpointArgs args, InvokeOptions options)
public static Output<GetPrivateEndpointResult> getPrivateEndpoint(GetPrivateEndpointArgs args, InvokeOptions options)

    fn::invoke:
  function: oci:ResourceManager/getPrivateEndpoint:getPrivateEndpoint
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PrivateEndpointId string
    The OCID of the private endpoint.
    PrivateEndpointId string
    The OCID of the private endpoint.
    privateEndpointId String
    The OCID of the private endpoint.
    privateEndpointId string
    The OCID of the private endpoint.
    private_endpoint_id str
    The OCID of the private endpoint.
    privateEndpointId String
    The OCID of the private endpoint.

    getPrivateEndpoint Result

    The following output properties are available:

    CompartmentId string
    The OCID of the compartment containing this private endpoint.
    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 user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    DnsZones List<string>
    DNS zones to use for accessing private Git servers. For private Git server instructions, see Private Git Server. Specify DNS fully qualified domain names (FQDNs); DNS Proxy forwards related DNS FQDN queries to the consumer DNS resolver. For DNS FQDNs not specified, queries go to service provider VCN resolver. Example: abc.oraclevcn.com
    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
    The OCID of the private endpoint.
    IsUsedWithConfigurationSourceProvider bool
    When true, allows the private endpoint to be used with a configuration source provider.
    NsgIdLists List<string>
    The OCIDs of network security groups (NSGs) for the private endpoint. Order does not matter.
    PrivateEndpointId string
    SecurityAttributes Dictionary<string, string>
    Security attributes are labels for a resource that can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}
    SourceIps List<string>
    The source IP addresses that Resource Manager uses to connect to your network. Automatically assigned by Resource Manager.
    State string
    The current lifecycle state of the private endpoint.
    SubnetId string
    The OCID of the subnet within the VCN for the private endpoint.
    SystemTags Dictionary<string, string>
    The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    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 for the private endpoint.
    CompartmentId string
    The OCID of the compartment containing this private endpoint.
    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 user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    DnsZones []string
    DNS zones to use for accessing private Git servers. For private Git server instructions, see Private Git Server. Specify DNS fully qualified domain names (FQDNs); DNS Proxy forwards related DNS FQDN queries to the consumer DNS resolver. For DNS FQDNs not specified, queries go to service provider VCN resolver. Example: abc.oraclevcn.com
    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
    The OCID of the private endpoint.
    IsUsedWithConfigurationSourceProvider bool
    When true, allows the private endpoint to be used with a configuration source provider.
    NsgIdLists []string
    The OCIDs of network security groups (NSGs) for the private endpoint. Order does not matter.
    PrivateEndpointId string
    SecurityAttributes map[string]string
    Security attributes are labels for a resource that can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}
    SourceIps []string
    The source IP addresses that Resource Manager uses to connect to your network. Automatically assigned by Resource Manager.
    State string
    The current lifecycle state of the private endpoint.
    SubnetId string
    The OCID of the subnet within the VCN for the private endpoint.
    SystemTags map[string]string
    The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    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 for the private endpoint.
    compartmentId String
    The OCID of the compartment containing this private endpoint.
    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 user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    dnsZones List<String>
    DNS zones to use for accessing private Git servers. For private Git server instructions, see Private Git Server. Specify DNS fully qualified domain names (FQDNs); DNS Proxy forwards related DNS FQDN queries to the consumer DNS resolver. For DNS FQDNs not specified, queries go to service provider VCN resolver. Example: abc.oraclevcn.com
    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
    The OCID of the private endpoint.
    isUsedWithConfigurationSourceProvider Boolean
    When true, allows the private endpoint to be used with a configuration source provider.
    nsgIdLists List<String>
    The OCIDs of network security groups (NSGs) for the private endpoint. Order does not matter.
    privateEndpointId String
    securityAttributes Map<String,String>
    Security attributes are labels for a resource that can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}
    sourceIps List<String>
    The source IP addresses that Resource Manager uses to connect to your network. Automatically assigned by Resource Manager.
    state String
    The current lifecycle state of the private endpoint.
    subnetId String
    The OCID of the subnet within the VCN for the private endpoint.
    systemTags Map<String,String>
    The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    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 for the private endpoint.
    compartmentId string
    The OCID of the compartment containing this private endpoint.
    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 user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    dnsZones string[]
    DNS zones to use for accessing private Git servers. For private Git server instructions, see Private Git Server. Specify DNS fully qualified domain names (FQDNs); DNS Proxy forwards related DNS FQDN queries to the consumer DNS resolver. For DNS FQDNs not specified, queries go to service provider VCN resolver. Example: abc.oraclevcn.com
    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
    The OCID of the private endpoint.
    isUsedWithConfigurationSourceProvider boolean
    When true, allows the private endpoint to be used with a configuration source provider.
    nsgIdLists string[]
    The OCIDs of network security groups (NSGs) for the private endpoint. Order does not matter.
    privateEndpointId string
    securityAttributes {[key: string]: string}
    Security attributes are labels for a resource that can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}
    sourceIps string[]
    The source IP addresses that Resource Manager uses to connect to your network. Automatically assigned by Resource Manager.
    state string
    The current lifecycle state of the private endpoint.
    subnetId string
    The OCID of the subnet within the VCN for the private endpoint.
    systemTags {[key: string]: string}
    The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    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 for the private endpoint.
    compartment_id str
    The OCID of the compartment containing this private endpoint.
    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 user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    dns_zones Sequence[str]
    DNS zones to use for accessing private Git servers. For private Git server instructions, see Private Git Server. Specify DNS fully qualified domain names (FQDNs); DNS Proxy forwards related DNS FQDN queries to the consumer DNS resolver. For DNS FQDNs not specified, queries go to service provider VCN resolver. Example: abc.oraclevcn.com
    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
    The OCID of the private endpoint.
    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]
    The OCIDs of network security groups (NSGs) for the private endpoint. Order does not matter.
    private_endpoint_id str
    security_attributes Mapping[str, str]
    Security attributes are labels for a resource that can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}
    source_ips Sequence[str]
    The source IP addresses that Resource Manager uses to connect to your network. Automatically assigned by Resource Manager.
    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.
    system_tags Mapping[str, str]
    The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    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 for the private endpoint.
    compartmentId String
    The OCID of the compartment containing this private endpoint.
    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 user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
    dnsZones List<String>
    DNS zones to use for accessing private Git servers. For private Git server instructions, see Private Git Server. Specify DNS fully qualified domain names (FQDNs); DNS Proxy forwards related DNS FQDN queries to the consumer DNS resolver. For DNS FQDNs not specified, queries go to service provider VCN resolver. Example: abc.oraclevcn.com
    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
    The OCID of the private endpoint.
    isUsedWithConfigurationSourceProvider Boolean
    When true, allows the private endpoint to be used with a configuration source provider.
    nsgIdLists List<String>
    The OCIDs of network security groups (NSGs) for the private endpoint. Order does not matter.
    privateEndpointId String
    securityAttributes Map<String>
    Security attributes are labels for a resource that can be referenced in a Zero Trust Packet Routing (ZPR) policy to control access to ZPR-supported resources. Example: {"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}
    sourceIps List<String>
    The source IP addresses that Resource Manager uses to connect to your network. Automatically assigned by Resource Manager.
    state String
    The current lifecycle state of the private endpoint.
    subnetId String
    The OCID of the subnet within the VCN for the private endpoint.
    systemTags Map<String>
    The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: true}}
    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 for the private endpoint.

    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.10.0 published on Wednesday, Nov 5, 2025 by Pulumi
    pulumi/pulumi-oci
      Meet Neo: Your AI Platform Teammate