oci.ObjectStorage.getPrivateEndpoint

Oracle Cloud Infrastructure v4.19.0, Jul 9 26

Viewing docs for Oracle Cloud Infrastructure v4.19.0
published on Thursday, Jul 9, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-oci

Viewing docs for Oracle Cloud Infrastructure v4.19.0
published on Thursday, Jul 9, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-oci

Example Usage

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

const testPe = oci.objectstorage.getPrivateEndpoint({
    name: peName,
    namespace: namespace,
});

import pulumi
import pulumi_oci as oci

test_pe = oci.objectstorage.get_private_endpoint(name=pe_name,
    namespace=namespace)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := objectstorage.GetPrivateEndpoint(ctx, &objectstorage.GetPrivateEndpointArgs{
			Name:      peName,
			Namespace: namespace,
		}, 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 testPe = Oci.ObjectStorage.GetPrivateEndpoint.Invoke(new()
    {
        Name = peName,
        Namespace = @namespace,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.ObjectStorage.ObjectStorageFunctions;
import com.pulumi.oci.ObjectStorage.inputs.GetPrivateEndpointArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 testPe = ObjectStorageFunctions.getPrivateEndpoint(GetPrivateEndpointArgs.builder()
            .name(peName)
            .namespace(namespace)
            .build());

    }
}

variables:
  testPe:
    fn::invoke:
      function: oci:ObjectStorage:getPrivateEndpoint
      arguments:
        name: ${peName}
        namespace: ${namespace}

pulumi {
  required_providers {
    oci = {
      source = "pulumi/oci"
    }
  }
}

data "oci_objectstorage_getprivateendpoint" "testPe" {
  name      = peName
  namespace = namespace
}

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(name: Optional[str] = None,
                         namespace: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointResult
def get_private_endpoint_output(name: pulumi.Input[Optional[str]] = None,
                         namespace: pulumi.Input[Optional[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:ObjectStorage/getPrivateEndpoint:getPrivateEndpoint
  arguments:
    # arguments dictionary

data "oci_objectstorage_getprivateendpoint" "name" {
    # arguments
}

The following arguments are supported:

Name string: The name of the private endpoint. Avoid entering confidential information. Example: my-pe1
Namespace string: The Object Storage namespace used for the request.

Name string: The name of the private endpoint. Avoid entering confidential information. Example: my-pe1
Namespace string: The Object Storage namespace used for the request.

name string: The name of the private endpoint. Avoid entering confidential information. Example: my-pe1
namespace string: The Object Storage namespace used for the request.

name String: The name of the private endpoint. Avoid entering confidential information. Example: my-pe1
namespace String: The Object Storage namespace used for the request.

name string: The name of the private endpoint. Avoid entering confidential information. Example: my-pe1
namespace string: The Object Storage namespace used for the request.

name str: The name of the private endpoint. Avoid entering confidential information. Example: my-pe1
namespace str: The Object Storage namespace used for the request.

name String: The name of the private endpoint. Avoid entering confidential information. Example: my-pe1
namespace String: The Object Storage namespace used for the request.

getPrivateEndpoint Result

The following output properties are available:

AccessTargets List<GetPrivateEndpointAccessTarget>
AdditionalPrefixes List<string>
CompartmentId string: The compartment ID in which the private endpoint resource exists in.
CreatedBy string: The OCID of the user who created the private endpoint.
DefinedTags Dictionary<string, string>
Etag string: The entity tag for the Private Endpoint.
Fqdns Dictionary<string, ImmutableDictionary<string, ImmutableDictionary<string, string>>>: The object representing FQDN details formed using prefix and additionalPrefixes.
FreeformTags Dictionary<string, string>
Id string
Name string: The name of the private endpoint. Avoid entering confidential information. Example: my-pe1
Namespace string: The Object Storage namespace in which the private endpoint resides.
NsgIds List<string>
Prefix string: The DNS prefix value chosen which is the first part of the URL used to access Object Storage.
PrivateEndpointIp string
SecurityAttributes Dictionary<string, string>
State string: The lifecycle state of the private endpoint resource.
SubnetId string
TimeCreated string: The date and time the private endpoint was created, as described in RFC 2616.
TimeModified string: The date and time the private endpoint was updated, as described in RFC 2616.

AccessTargets []GetPrivateEndpointAccessTarget
AdditionalPrefixes []string
CompartmentId string: The compartment ID in which the private endpoint resource exists in.
CreatedBy string: The OCID of the user who created the private endpoint.
DefinedTags map[string]string
Etag string: The entity tag for the Private Endpoint.
Fqdns map[string]map[string]map[string]string: The object representing FQDN details formed using prefix and additionalPrefixes.
FreeformTags map[string]string
Id string
Name string: The name of the private endpoint. Avoid entering confidential information. Example: my-pe1
Namespace string: The Object Storage namespace in which the private endpoint resides.
NsgIds []string
Prefix string: The DNS prefix value chosen which is the first part of the URL used to access Object Storage.
PrivateEndpointIp string
SecurityAttributes map[string]string
State string: The lifecycle state of the private endpoint resource.
SubnetId string
TimeCreated string: The date and time the private endpoint was created, as described in RFC 2616.
TimeModified string: The date and time the private endpoint was updated, as described in RFC 2616.

access_targets list(object)
additional_prefixes list(string)
compartment_id string: The compartment ID in which the private endpoint resource exists in.
created_by string: The OCID of the user who created the private endpoint.
defined_tags map(string)
etag string: The entity tag for the Private Endpoint.
fqdns map(map(map(string))): The object representing FQDN details formed using prefix and additionalPrefixes.
freeform_tags map(string)
id string
name string: The name of the private endpoint. Avoid entering confidential information. Example: my-pe1
namespace string: The Object Storage namespace in which the private endpoint resides.
nsg_ids list(string)
prefix string: The DNS prefix value chosen which is the first part of the URL used to access Object Storage.
private_endpoint_ip string
security_attributes map(string)
state string: The lifecycle state of the private endpoint resource.
subnet_id string
time_created string: The date and time the private endpoint was created, as described in RFC 2616.
time_modified string: The date and time the private endpoint was updated, as described in RFC 2616.

accessTargets List<GetPrivateEndpointAccessTarget>
additionalPrefixes List<String>
compartmentId String: The compartment ID in which the private endpoint resource exists in.
createdBy String: The OCID of the user who created the private endpoint.
definedTags Map<String,String>
etag String: The entity tag for the Private Endpoint.
fqdns Map<String,Map<String,Map<String,String>>>: The object representing FQDN details formed using prefix and additionalPrefixes.
freeformTags Map<String,String>
id String
name String: The name of the private endpoint. Avoid entering confidential information. Example: my-pe1
namespace String: The Object Storage namespace in which the private endpoint resides.
nsgIds List<String>
prefix String: The DNS prefix value chosen which is the first part of the URL used to access Object Storage.
privateEndpointIp String
securityAttributes Map<String,String>
state String: The lifecycle state of the private endpoint resource.
subnetId String
timeCreated String: The date and time the private endpoint was created, as described in RFC 2616.
timeModified String: The date and time the private endpoint was updated, as described in RFC 2616.

accessTargets GetPrivateEndpointAccessTarget[]
additionalPrefixes string[]
compartmentId string: The compartment ID in which the private endpoint resource exists in.
createdBy string: The OCID of the user who created the private endpoint.
definedTags {[key: string]: string}
etag string: The entity tag for the Private Endpoint.
fqdns {[key: string]: {[key: string]: {[key: string]: string}}}: The object representing FQDN details formed using prefix and additionalPrefixes.
freeformTags {[key: string]: string}
id string
name string: The name of the private endpoint. Avoid entering confidential information. Example: my-pe1
namespace string: The Object Storage namespace in which the private endpoint resides.
nsgIds string[]
prefix string: The DNS prefix value chosen which is the first part of the URL used to access Object Storage.
privateEndpointIp string
securityAttributes {[key: string]: string}
state string: The lifecycle state of the private endpoint resource.
subnetId string
timeCreated string: The date and time the private endpoint was created, as described in RFC 2616.
timeModified string: The date and time the private endpoint was updated, as described in RFC 2616.

access_targets Sequence[GetPrivateEndpointAccessTarget]
additional_prefixes Sequence[str]
compartment_id str: The compartment ID in which the private endpoint resource exists in.
created_by str: The OCID of the user who created the private endpoint.
defined_tags Mapping[str, str]
etag str: The entity tag for the Private Endpoint.
fqdns Mapping[str, Mapping[str, Mapping[str, str]]]: The object representing FQDN details formed using prefix and additionalPrefixes.
freeform_tags Mapping[str, str]
id str
name str: The name of the private endpoint. Avoid entering confidential information. Example: my-pe1
namespace str: The Object Storage namespace in which the private endpoint resides.
nsg_ids Sequence[str]
prefix str: The DNS prefix value chosen which is the first part of the URL used to access Object Storage.
private_endpoint_ip str
security_attributes Mapping[str, str]
state str: The lifecycle state of the private endpoint resource.
subnet_id str
time_created str: The date and time the private endpoint was created, as described in RFC 2616.
time_modified str: The date and time the private endpoint was updated, as described in RFC 2616.

accessTargets List<Property Map>
additionalPrefixes List<String>
compartmentId String: The compartment ID in which the private endpoint resource exists in.
createdBy String: The OCID of the user who created the private endpoint.
definedTags Map<String>
etag String: The entity tag for the Private Endpoint.
fqdns Map<Map<Map<String>>>: The object representing FQDN details formed using prefix and additionalPrefixes.
freeformTags Map<String>
id String
name String: The name of the private endpoint. Avoid entering confidential information. Example: my-pe1
namespace String: The Object Storage namespace in which the private endpoint resides.
nsgIds List<String>
prefix String: The DNS prefix value chosen which is the first part of the URL used to access Object Storage.
privateEndpointIp String
securityAttributes Map<String>
state String: The lifecycle state of the private endpoint resource.
subnetId String
timeCreated String: The date and time the private endpoint was created, as described in RFC 2616.
timeModified String: The date and time the private endpoint was updated, as described in RFC 2616.

Supporting Types

GetPrivateEndpointAccessTarget

Bucket string
CompartmentId string: The compartment ID in which the private endpoint resource exists in.
Namespace string: The Object Storage namespace used for the request.

Bucket string
CompartmentId string: The compartment ID in which the private endpoint resource exists in.
Namespace string: The Object Storage namespace used for the request.

bucket string
compartment_id string: The compartment ID in which the private endpoint resource exists in.
namespace string: The Object Storage namespace used for the request.

bucket String
compartmentId String: The compartment ID in which the private endpoint resource exists in.
namespace String: The Object Storage namespace used for the request.

bucket string
compartmentId string: The compartment ID in which the private endpoint resource exists in.
namespace string: The Object Storage namespace used for the request.

bucket str
compartment_id str: The compartment ID in which the private endpoint resource exists in.
namespace str: The Object Storage namespace used for the request.

bucket String
compartmentId String: The compartment ID in which the private endpoint resource exists in.
namespace String: The Object Storage namespace used for the request.

Package Details

Repository: oci pulumi/pulumi-oci
License: Apache-2.0
Notes: This Pulumi package is based on the oci Terraform Provider.

Viewing docs for Oracle Cloud Infrastructure v4.19.0
published on Thursday, Jul 9, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-oci

oci.ObjectStorage.getPrivateEndpoint

On this page

On this page

Example Usage

Using getPrivateEndpoint

getPrivateEndpoint Result

Supporting Types

GetPrivateEndpointAccessTarget

Package Details

On this page

On this page

Try Pulumi Cloud free.
Your team will thank you.

oci.ObjectStorage.getPrivateEndpoint

On this page

On this page

Example Usage

Using getPrivateEndpoint

getPrivateEndpoint Result

Supporting Types

GetPrivateEndpointAccessTarget

Package Details

On this page

On this page

Try Pulumi Cloud free.Your team will thank you.

Try Pulumi Cloud free.
Your team will thank you.