Oracle Cloud Infrastructure v2.33.0, May 1 25

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

oci.DataScience.getPrivateEndpoints

Explore with Pulumi AI

Oracle Cloud Infrastructure v2.33.0 published on Thursday, May 1, 2025 by Pulumi

Example Usage

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

const testDataSciencePrivateEndpoints = oci.DataScience.getPrivateEndpoints({
    compartmentId: compartmentId,
    createdBy: dataSciencePrivateEndpointCreatedBy,
    dataScienceResourceType: dataSciencePrivateEndpointDataScienceResourceType,
    displayName: dataSciencePrivateEndpointDisplayName,
    state: dataSciencePrivateEndpointState,
});

import pulumi
import pulumi_oci as oci

test_data_science_private_endpoints = oci.DataScience.get_private_endpoints(compartment_id=compartment_id,
    created_by=data_science_private_endpoint_created_by,
    data_science_resource_type=data_science_private_endpoint_data_science_resource_type,
    display_name=data_science_private_endpoint_display_name,
    state=data_science_private_endpoint_state)

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datascience.GetPrivateEndpoints(ctx, &datascience.GetPrivateEndpointsArgs{
			CompartmentId:           compartmentId,
			CreatedBy:               pulumi.StringRef(dataSciencePrivateEndpointCreatedBy),
			DataScienceResourceType: pulumi.StringRef(dataSciencePrivateEndpointDataScienceResourceType),
			DisplayName:             pulumi.StringRef(dataSciencePrivateEndpointDisplayName),
			State:                   pulumi.StringRef(dataSciencePrivateEndpointState),
		}, 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 testDataSciencePrivateEndpoints = Oci.DataScience.GetPrivateEndpoints.Invoke(new()
    {
        CompartmentId = compartmentId,
        CreatedBy = dataSciencePrivateEndpointCreatedBy,
        DataScienceResourceType = dataSciencePrivateEndpointDataScienceResourceType,
        DisplayName = dataSciencePrivateEndpointDisplayName,
        State = dataSciencePrivateEndpointState,
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataScience.DataScienceFunctions;
import com.pulumi.oci.DataScience.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 testDataSciencePrivateEndpoints = DataScienceFunctions.getPrivateEndpoints(GetPrivateEndpointsArgs.builder()
            .compartmentId(compartmentId)
            .createdBy(dataSciencePrivateEndpointCreatedBy)
            .dataScienceResourceType(dataSciencePrivateEndpointDataScienceResourceType)
            .displayName(dataSciencePrivateEndpointDisplayName)
            .state(dataSciencePrivateEndpointState)
            .build());

    }
}

variables:
  testDataSciencePrivateEndpoints:
    fn::invoke:
      function: oci:DataScience:getPrivateEndpoints
      arguments:
        compartmentId: ${compartmentId}
        createdBy: ${dataSciencePrivateEndpointCreatedBy}
        dataScienceResourceType: ${dataSciencePrivateEndpointDataScienceResourceType}
        displayName: ${dataSciencePrivateEndpointDisplayName}
        state: ${dataSciencePrivateEndpointState}

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,
                          created_by: Optional[str] = None,
                          data_science_resource_type: Optional[str] = None,
                          display_name: Optional[str] = None,
                          filters: Optional[Sequence[GetPrivateEndpointsFilter]] = None,
                          state: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetPrivateEndpointsResult
def get_private_endpoints_output(compartment_id: Optional[pulumi.Input[str]] = None,
                          created_by: Optional[pulumi.Input[str]] = None,
                          data_science_resource_type: Optional[pulumi.Input[str]] = None,
                          display_name: Optional[pulumi.Input[str]] = None,
                          filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetPrivateEndpointsFilterArgs]]]] = None,
                          state: 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:DataScience/getPrivateEndpoints:getPrivateEndpoints
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: Filter results by the OCID of the compartment.
CreatedBy string: Filter results by the OCID of the user who created the resource.
DataScienceResourceType string: Resource types in the Data Science service such as notebooks.
DisplayName string: Filter results by its user-friendly name.
Filters List<GetPrivateEndpointsFilter>
State string: The lifecycle state of the private endpoint.

CompartmentId string: Filter results by the OCID of the compartment.
CreatedBy string: Filter results by the OCID of the user who created the resource.
DataScienceResourceType string: Resource types in the Data Science service such as notebooks.
DisplayName string: Filter results by its user-friendly name.
Filters []GetPrivateEndpointsFilter
State string: The lifecycle state of the private endpoint.

compartmentId String: Filter results by the OCID of the compartment.
createdBy String: Filter results by the OCID of the user who created the resource.
dataScienceResourceType String: Resource types in the Data Science service such as notebooks.
displayName String: Filter results by its user-friendly name.
filters List<GetPrivateEndpointsFilter>
state String: The lifecycle state of the private endpoint.

compartmentId string: Filter results by the OCID of the compartment.
createdBy string: Filter results by the OCID of the user who created the resource.
dataScienceResourceType string: Resource types in the Data Science service such as notebooks.
displayName string: Filter results by its user-friendly name.
filters GetPrivateEndpointsFilter[]
state string: The lifecycle state of the private endpoint.

compartment_id str: Filter results by the OCID of the compartment.
created_by str: Filter results by the OCID of the user who created the resource.
data_science_resource_type str: Resource types in the Data Science service such as notebooks.
display_name str: Filter results by its user-friendly name.
filters Sequence[GetPrivateEndpointsFilter]
state str: The lifecycle state of the private endpoint.

compartmentId String: Filter results by the OCID of the compartment.
createdBy String: Filter results by the OCID of the user who created the resource.
dataScienceResourceType String: Resource types in the Data Science service such as notebooks.
displayName String: Filter results by its user-friendly name.
filters List<Property Map>
state String: The lifecycle state of the private endpoint.

getPrivateEndpoints Result

The following output properties are available:

CompartmentId string: The OCID of the compartment where you want to create private endpoint.
DataSciencePrivateEndpoints List<GetPrivateEndpointsDataSciencePrivateEndpoint>: The list of data_science_private_endpoints.
Id string: The provider-assigned unique ID for this managed resource.
CreatedBy string: The OCID of the user that created the private endpoint.
DataScienceResourceType string: Data Science resource type.
DisplayName string: A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
Filters List<GetPrivateEndpointsFilter>
State string: State of the Data Science private endpoint.

CompartmentId string: The OCID of the compartment where you want to create private endpoint.
DataSciencePrivateEndpoints []GetPrivateEndpointsDataSciencePrivateEndpoint: The list of data_science_private_endpoints.
Id string: The provider-assigned unique ID for this managed resource.
CreatedBy string: The OCID of the user that created the private endpoint.
DataScienceResourceType string: Data Science resource type.
DisplayName string: A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
Filters []GetPrivateEndpointsFilter
State string: State of the Data Science private endpoint.

compartmentId String: The OCID of the compartment where you want to create private endpoint.
dataSciencePrivateEndpoints List<GetPrivateEndpointsPrivateEndpoint>: The list of data_science_private_endpoints.
id String: The provider-assigned unique ID for this managed resource.
createdBy String: The OCID of the user that created the private endpoint.
dataScienceResourceType String: Data Science resource type.
displayName String: A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
filters List<GetPrivateEndpointsFilter>
state String: State of the Data Science private endpoint.

compartmentId string: The OCID of the compartment where you want to create private endpoint.
dataSciencePrivateEndpoints GetPrivateEndpointsDataSciencePrivateEndpoint[]: The list of data_science_private_endpoints.
id string: The provider-assigned unique ID for this managed resource.
createdBy string: The OCID of the user that created the private endpoint.
dataScienceResourceType string: Data Science resource type.
displayName string: A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
filters GetPrivateEndpointsFilter[]
state string: State of the Data Science private endpoint.

compartment_id str: The OCID of the compartment where you want to create private endpoint.
data_science_private_endpoints Sequence[GetPrivateEndpointsDataSciencePrivateEndpoint]: The list of data_science_private_endpoints.
id str: The provider-assigned unique ID for this managed resource.
created_by str: The OCID of the user that created the private endpoint.
data_science_resource_type str: Data Science resource type.
display_name str: A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
filters Sequence[GetPrivateEndpointsFilter]
state str: State of the Data Science private endpoint.

compartmentId String: The OCID of the compartment where you want to create private endpoint.
dataSciencePrivateEndpoints List<Property Map>: The list of data_science_private_endpoints.
id String: The provider-assigned unique ID for this managed resource.
createdBy String: The OCID of the user that created the private endpoint.
dataScienceResourceType String: Data Science resource type.
displayName String: A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
filters List<Property Map>
state String: State of the Data Science private endpoint.

Supporting Types

GetPrivateEndpointsDataSciencePrivateEndpoint

CompartmentId string: Filter results by the OCID of the compartment.
CreatedBy string: Filter results by the OCID of the user who created the resource.
DataScienceResourceType string: Resource types in the Data Science service such as notebooks.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: A user friendly description. Avoid entering confidential information.
DisplayName string: Filter results by its user-friendly name.
Fqdn string: Accesing the Data Science resource using FQDN.
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. See Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of a private endpoint.
LifecycleDetails string: Details of the state of Data Science private endpoint.
NsgIds List<string>: An array of network security group OCIDs.
State string: The lifecycle state of the private endpoint.
SubDomain string
SubnetId string: The OCID of a subnet.
SystemTags Dictionary<string, string>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The date and time that the Data Science private endpoint was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
TimeUpdated string: The date and time that the Data Science private endpoint was updated expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

CompartmentId string: Filter results by the OCID of the compartment.
CreatedBy string: Filter results by the OCID of the user who created the resource.
DataScienceResourceType string: Resource types in the Data Science service such as notebooks.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
Description string: A user friendly description. Avoid entering confidential information.
DisplayName string: Filter results by its user-friendly name.
Fqdn string: Accesing the Data Science resource using FQDN.
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. See Resource Tags. Example: {"Department": "Finance"}
Id string: The OCID of a private endpoint.
LifecycleDetails string: Details of the state of Data Science private endpoint.
NsgIds []string: An array of network security group OCIDs.
State string: The lifecycle state of the private endpoint.
SubDomain string
SubnetId string: The OCID of a subnet.
SystemTags map[string]string: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
TimeCreated string: The date and time that the Data Science private endpoint was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
TimeUpdated string: The date and time that the Data Science private endpoint was updated expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

compartmentId String: Filter results by the OCID of the compartment.
createdBy String: Filter results by the OCID of the user who created the resource.
dataScienceResourceType String: Resource types in the Data Science service such as notebooks.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: A user friendly description. Avoid entering confidential information.
displayName String: Filter results by its user-friendly name.
fqdn String: Accesing the Data Science resource using FQDN.
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. See Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of a private endpoint.
lifecycleDetails String: Details of the state of Data Science private endpoint.
nsgIds List<String>: An array of network security group OCIDs.
state String: The lifecycle state of the private endpoint.
subDomain String
subnetId String: The OCID of a subnet.
systemTags Map<String,String>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The date and time that the Data Science private endpoint was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
timeUpdated String: The date and time that the Data Science private endpoint was updated expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

compartmentId string: Filter results by the OCID of the compartment.
createdBy string: Filter results by the OCID of the user who created the resource.
dataScienceResourceType string: Resource types in the Data Science service such as notebooks.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
description string: A user friendly description. Avoid entering confidential information.
displayName string: Filter results by its user-friendly name.
fqdn string: Accesing the Data Science resource using FQDN.
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. See Resource Tags. Example: {"Department": "Finance"}
id string: The OCID of a private endpoint.
lifecycleDetails string: Details of the state of Data Science private endpoint.
nsgIds string[]: An array of network security group OCIDs.
state string: The lifecycle state of the private endpoint.
subDomain string
subnetId string: The OCID of a subnet.
systemTags {[key: string]: string}: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated string: The date and time that the Data Science private endpoint was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
timeUpdated string: The date and time that the Data Science private endpoint was updated expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

compartment_id str: Filter results by the OCID of the compartment.
created_by str: Filter results by the OCID of the user who created the resource.
data_science_resource_type str: Resource types in the Data Science service such as notebooks.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
description str: A user friendly description. Avoid entering confidential information.
display_name str: Filter results by its user-friendly name.
fqdn str: Accesing the Data Science resource using FQDN.
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. See Resource Tags. Example: {"Department": "Finance"}
id str: The OCID of a private endpoint.
lifecycle_details str: Details of the state of Data Science private endpoint.
nsg_ids Sequence[str]: An array of network security group OCIDs.
state str: The lifecycle state of the private endpoint.
sub_domain str
subnet_id str: The OCID of a subnet.
system_tags Mapping[str, str]: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
time_created str: The date and time that the Data Science private endpoint was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
time_updated str: The date and time that the Data Science private endpoint was updated expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

compartmentId String: Filter results by the OCID of the compartment.
createdBy String: Filter results by the OCID of the user who created the resource.
dataScienceResourceType String: Resource types in the Data Science service such as notebooks.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {"Operations.CostCenter": "42"}
description String: A user friendly description. Avoid entering confidential information.
displayName String: Filter results by its user-friendly name.
fqdn String: Accesing the Data Science resource using FQDN.
freeformTags Map<String>: Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {"Department": "Finance"}
id String: The OCID of a private endpoint.
lifecycleDetails String: Details of the state of Data Science private endpoint.
nsgIds List<String>: An array of network security group OCIDs.
state String: The lifecycle state of the private endpoint.
subDomain String
subnetId String: The OCID of a subnet.
systemTags Map<String>: Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {"orcl-cloud.free-tier-retained": "true"}
timeCreated String: The date and time that the Data Science private endpoint was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
timeUpdated String: The date and time that the Data Science private endpoint was updated expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

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

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

pulumi/pulumi-oci

oci.DataScience.getPrivateEndpoints

On this page

On this page

Example Usage

Using getPrivateEndpoints

getPrivateEndpoints Result

Supporting Types

GetPrivateEndpointsDataSciencePrivateEndpoint

GetPrivateEndpointsFilter

Package Details

On this page

On this page