Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataFlow
  5. getPrivateEndpoint
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

oci.DataFlow.getPrivateEndpoint

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi
pulumi/pulumi-oci

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

    Retrieves an private endpoint using a privateEndpointId.

    Example Usage

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

const testPrivateEndpoint = oci.DataFlow.getPrivateEndpoint({
    privateEndpointId: testPrivateEndpointOciDataflowPrivateEndpoint.id,
});

    import pulumi
import pulumi_oci as oci

test_private_endpoint = oci.DataFlow.get_private_endpoint(private_endpoint_id=test_private_endpoint_oci_dataflow_private_endpoint["id"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := dataflow.GetPrivateEndpoint(ctx, &dataflow.GetPrivateEndpointArgs{
			PrivateEndpointId: testPrivateEndpointOciDataflowPrivateEndpoint.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.DataFlow.GetPrivateEndpoint.Invoke(new()
    {
        PrivateEndpointId = testPrivateEndpointOciDataflowPrivateEndpoint.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataFlow.DataFlowFunctions;
import com.pulumi.oci.DataFlow.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 = DataFlowFunctions.getPrivateEndpoint(GetPrivateEndpointArgs.builder()
            .privateEndpointId(testPrivateEndpointOciDataflowPrivateEndpoint.id())
            .build());

    }
}

    variables:
  testPrivateEndpoint:
    fn::invoke:
      function: oci:DataFlow:getPrivateEndpoint
      arguments:
        privateEndpointId: ${testPrivateEndpointOciDataflowPrivateEndpoint.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:DataFlow/getPrivateEndpoint:getPrivateEndpoint
  arguments:
    # arguments dictionary

    The following arguments are supported:

    PrivateEndpointId string
    The unique ID for a private endpoint.
    PrivateEndpointId string
    The unique ID for a private endpoint.
    privateEndpointId String
    The unique ID for a private endpoint.
    privateEndpointId string
    The unique ID for a private endpoint.
    private_endpoint_id str
    The unique ID for a private endpoint.
    privateEndpointId String
    The unique ID for a private endpoint.

    getPrivateEndpoint Result

    The following output properties are available:

    CompartmentId string
    The OCID of a compartment.
    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
    A user-friendly description. Avoid entering confidential information.
    DisplayName string
    A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    DnsZones List<string>
    An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
    FreeformTags Dictionary<string, string>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of a private endpoint.
    LifecycleDetails string
    The detailed messages about the lifecycle state.
    MaxHostCount int
    The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
    NsgIds List<string>
    An array of network security group OCIDs.
    OwnerPrincipalId string
    The OCID of the user who created the resource.
    OwnerUserName string
    The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
    PrivateEndpointId string
    ScanDetails List<GetPrivateEndpointScanDetail>
    An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
    State string
    The current state of this private endpoint.
    SubnetId string
    The OCID of a subnet.
    TimeCreated string
    The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    TimeUpdated string
    The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    CompartmentId string
    The OCID of a compartment.
    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
    A user-friendly description. Avoid entering confidential information.
    DisplayName string
    A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    DnsZones []string
    An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
    FreeformTags map[string]string
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of a private endpoint.
    LifecycleDetails string
    The detailed messages about the lifecycle state.
    MaxHostCount int
    The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
    NsgIds []string
    An array of network security group OCIDs.
    OwnerPrincipalId string
    The OCID of the user who created the resource.
    OwnerUserName string
    The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
    PrivateEndpointId string
    ScanDetails []GetPrivateEndpointScanDetail
    An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
    State string
    The current state of this private endpoint.
    SubnetId string
    The OCID of a subnet.
    TimeCreated string
    The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    TimeUpdated string
    The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    compartmentId String
    The OCID of a compartment.
    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
    A user-friendly description. Avoid entering confidential information.
    displayName String
    A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    dnsZones List<String>
    An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
    freeformTags Map<String,String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of a private endpoint.
    lifecycleDetails String
    The detailed messages about the lifecycle state.
    maxHostCount Integer
    The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
    nsgIds List<String>
    An array of network security group OCIDs.
    ownerPrincipalId String
    The OCID of the user who created the resource.
    ownerUserName String
    The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
    privateEndpointId String
    scanDetails List<GetPrivateEndpointScanDetail>
    An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
    state String
    The current state of this private endpoint.
    subnetId String
    The OCID of a subnet.
    timeCreated String
    The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    timeUpdated String
    The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    compartmentId string
    The OCID of a compartment.
    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
    A user-friendly description. Avoid entering confidential information.
    displayName string
    A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    dnsZones string[]
    An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
    freeformTags {[key: string]: string}
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    The OCID of a private endpoint.
    lifecycleDetails string
    The detailed messages about the lifecycle state.
    maxHostCount number
    The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
    nsgIds string[]
    An array of network security group OCIDs.
    ownerPrincipalId string
    The OCID of the user who created the resource.
    ownerUserName string
    The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
    privateEndpointId string
    scanDetails GetPrivateEndpointScanDetail[]
    An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
    state string
    The current state of this private endpoint.
    subnetId string
    The OCID of a subnet.
    timeCreated string
    The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    timeUpdated string
    The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    compartment_id str
    The OCID of a compartment.
    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
    A user-friendly description. Avoid entering confidential information.
    display_name str
    A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    dns_zones Sequence[str]
    An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
    freeform_tags Mapping[str, str]
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    The OCID of a private endpoint.
    lifecycle_details str
    The detailed messages about the lifecycle state.
    max_host_count int
    The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
    nsg_ids Sequence[str]
    An array of network security group OCIDs.
    owner_principal_id str
    The OCID of the user who created the resource.
    owner_user_name str
    The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
    private_endpoint_id str
    scan_details Sequence[GetPrivateEndpointScanDetail]
    An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
    state str
    The current state of this private endpoint.
    subnet_id str
    The OCID of a subnet.
    time_created str
    The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    time_updated str
    The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    compartmentId String
    The OCID of a compartment.
    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
    A user-friendly description. Avoid entering confidential information.
    displayName String
    A user-friendly name. It does not have to be unique. Avoid entering confidential information.
    dnsZones List<String>
    An array of DNS zone names. Example: [ "app.examplecorp.com", "app.examplecorp2.com" ]
    freeformTags Map<String>
    Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of a private endpoint.
    lifecycleDetails String
    The detailed messages about the lifecycle state.
    maxHostCount Number
    The maximum number of hosts to be accessed through the private endpoint. This value is used to calculate the relevant CIDR block and should be a multiple of 256. If the value is not a multiple of 256, it is rounded up to the next multiple of 256. For example, 300 is rounded up to 512.
    nsgIds List<String>
    An array of network security group OCIDs.
    ownerPrincipalId String
    The OCID of the user who created the resource.
    ownerUserName String
    The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.
    privateEndpointId String
    scanDetails List<Property Map>
    An array of fqdn/port pairs used to create private endpoint. Each object is a simple key-value pair with FQDN as key and port number as value. [ { fqdn: "scan1.oracle.com", port: "1521"}, { fqdn: "scan2.oracle.com", port: "1521" } ]
    state String
    The current state of this private endpoint.
    subnetId String
    The OCID of a subnet.
    timeCreated String
    The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    timeUpdated String
    The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

    Supporting Types

    GetPrivateEndpointScanDetail

    Fqdn string
    A fully-qualified domain name (FQDN).
    Port string
    The port number of the FQDN
    Fqdn string
    A fully-qualified domain name (FQDN).
    Port string
    The port number of the FQDN
    fqdn String
    A fully-qualified domain name (FQDN).
    port String
    The port number of the FQDN
    fqdn string
    A fully-qualified domain name (FQDN).
    port string
    The port number of the FQDN
    fqdn str
    A fully-qualified domain name (FQDN).
    port str
    The port number of the FQDN
    fqdn String
    A fully-qualified domain name (FQDN).
    port String
    The port number of the FQDN

    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 v2.33.0 published on Thursday, May 1, 2025 by Pulumi
    pulumi/pulumi-oci