1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. GenerativeAi
  5. getGenerativeAiPrivateEndpoints
Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

oci.GenerativeAi.getGenerativeAiPrivateEndpoints

Start a Neo task
Explain and create an oci.GenerativeAi.getGenerativeAiPrivateEndpoints resource
oci logo
Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

    This data source provides the list of Generative Ai Private Endpoints in Oracle Cloud Infrastructure Generative AI service.

    Lists all Generative AI private endpoints in the specified compartment.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testGenerativeAiPrivateEndpoints = oci.GenerativeAi.getGenerativeAiPrivateEndpoints({
        compartmentId: compartmentId,
        displayName: generativeAiPrivateEndpointDisplayName,
        id: generativeAiPrivateEndpointId,
        state: generativeAiPrivateEndpointState,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_generative_ai_private_endpoints = oci.GenerativeAi.get_generative_ai_private_endpoints(compartment_id=compartment_id,
        display_name=generative_ai_private_endpoint_display_name,
        id=generative_ai_private_endpoint_id,
        state=generative_ai_private_endpoint_state)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/generativeai"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := generativeai.GetGenerativeAiPrivateEndpoints(ctx, &generativeai.GetGenerativeAiPrivateEndpointsArgs{
    			CompartmentId: compartmentId,
    			DisplayName:   pulumi.StringRef(generativeAiPrivateEndpointDisplayName),
    			Id:            pulumi.StringRef(generativeAiPrivateEndpointId),
    			State:         pulumi.StringRef(generativeAiPrivateEndpointState),
    		}, 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 testGenerativeAiPrivateEndpoints = Oci.GenerativeAi.GetGenerativeAiPrivateEndpoints.Invoke(new()
        {
            CompartmentId = compartmentId,
            DisplayName = generativeAiPrivateEndpointDisplayName,
            Id = generativeAiPrivateEndpointId,
            State = generativeAiPrivateEndpointState,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.GenerativeAi.GenerativeAiFunctions;
    import com.pulumi.oci.GenerativeAi.inputs.GetGenerativeAiPrivateEndpointsArgs;
    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 testGenerativeAiPrivateEndpoints = GenerativeAiFunctions.getGenerativeAiPrivateEndpoints(GetGenerativeAiPrivateEndpointsArgs.builder()
                .compartmentId(compartmentId)
                .displayName(generativeAiPrivateEndpointDisplayName)
                .id(generativeAiPrivateEndpointId)
                .state(generativeAiPrivateEndpointState)
                .build());
    
        }
    }
    
    variables:
      testGenerativeAiPrivateEndpoints:
        fn::invoke:
          function: oci:GenerativeAi:getGenerativeAiPrivateEndpoints
          arguments:
            compartmentId: ${compartmentId}
            displayName: ${generativeAiPrivateEndpointDisplayName}
            id: ${generativeAiPrivateEndpointId}
            state: ${generativeAiPrivateEndpointState}
    

    Using getGenerativeAiPrivateEndpoints

    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 getGenerativeAiPrivateEndpoints(args: GetGenerativeAiPrivateEndpointsArgs, opts?: InvokeOptions): Promise<GetGenerativeAiPrivateEndpointsResult>
    function getGenerativeAiPrivateEndpointsOutput(args: GetGenerativeAiPrivateEndpointsOutputArgs, opts?: InvokeOptions): Output<GetGenerativeAiPrivateEndpointsResult>
    def get_generative_ai_private_endpoints(compartment_id: Optional[str] = None,
                                            display_name: Optional[str] = None,
                                            filters: Optional[Sequence[GetGenerativeAiPrivateEndpointsFilter]] = None,
                                            id: Optional[str] = None,
                                            state: Optional[str] = None,
                                            opts: Optional[InvokeOptions] = None) -> GetGenerativeAiPrivateEndpointsResult
    def get_generative_ai_private_endpoints_output(compartment_id: Optional[pulumi.Input[str]] = None,
                                            display_name: Optional[pulumi.Input[str]] = None,
                                            filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetGenerativeAiPrivateEndpointsFilterArgs]]]] = None,
                                            id: Optional[pulumi.Input[str]] = None,
                                            state: Optional[pulumi.Input[str]] = None,
                                            opts: Optional[InvokeOptions] = None) -> Output[GetGenerativeAiPrivateEndpointsResult]
    func GetGenerativeAiPrivateEndpoints(ctx *Context, args *GetGenerativeAiPrivateEndpointsArgs, opts ...InvokeOption) (*GetGenerativeAiPrivateEndpointsResult, error)
    func GetGenerativeAiPrivateEndpointsOutput(ctx *Context, args *GetGenerativeAiPrivateEndpointsOutputArgs, opts ...InvokeOption) GetGenerativeAiPrivateEndpointsResultOutput

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

    public static class GetGenerativeAiPrivateEndpoints 
    {
        public static Task<GetGenerativeAiPrivateEndpointsResult> InvokeAsync(GetGenerativeAiPrivateEndpointsArgs args, InvokeOptions? opts = null)
        public static Output<GetGenerativeAiPrivateEndpointsResult> Invoke(GetGenerativeAiPrivateEndpointsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetGenerativeAiPrivateEndpointsResult> getGenerativeAiPrivateEndpoints(GetGenerativeAiPrivateEndpointsArgs args, InvokeOptions options)
    public static Output<GetGenerativeAiPrivateEndpointsResult> getGenerativeAiPrivateEndpoints(GetGenerativeAiPrivateEndpointsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: oci:GenerativeAi/getGenerativeAiPrivateEndpoints:getGenerativeAiPrivateEndpoints
      arguments:
        # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment in which to list resources.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters List<GetGenerativeAiPrivateEndpointsFilter>
    Id string
    The OCID of the private endpoint.
    State string
    The lifecycle state of Generative AI private endpoints.
    CompartmentId string
    The OCID of the compartment in which to list resources.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    Filters []GetGenerativeAiPrivateEndpointsFilter
    Id string
    The OCID of the private endpoint.
    State string
    The lifecycle state of Generative AI private endpoints.
    compartmentId String
    The OCID of the compartment in which to list resources.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<GetPrivateEndpointsFilter>
    id String
    The OCID of the private endpoint.
    state String
    The lifecycle state of Generative AI private endpoints.
    compartmentId string
    The OCID of the compartment in which to list resources.
    displayName string
    A filter to return only resources that match the given display name exactly.
    filters GetGenerativeAiPrivateEndpointsFilter[]
    id string
    The OCID of the private endpoint.
    state string
    The lifecycle state of Generative AI private endpoints.
    compartment_id str
    The OCID of the compartment in which to list resources.
    display_name str
    A filter to return only resources that match the given display name exactly.
    filters Sequence[GetGenerativeAiPrivateEndpointsFilter]
    id str
    The OCID of the private endpoint.
    state str
    The lifecycle state of Generative AI private endpoints.
    compartmentId String
    The OCID of the compartment in which to list resources.
    displayName String
    A filter to return only resources that match the given display name exactly.
    filters List<Property Map>
    id String
    The OCID of the private endpoint.
    state String
    The lifecycle state of Generative AI private endpoints.

    getGenerativeAiPrivateEndpoints Result

    The following output properties are available:

    CompartmentId string
    GenerativeAiPrivateEndpointCollections List<GetGenerativeAiPrivateEndpointsGenerativeAiPrivateEndpointCollection>
    The list of generative_ai_private_endpoint_collection.
    DisplayName string
    A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    Filters List<GetGenerativeAiPrivateEndpointsFilter>
    Id string
    The OCID of a private endpoint.
    State string
    The current state of the Generative AI Private Endpoint.
    CompartmentId string
    GenerativeAiPrivateEndpointCollections []GetGenerativeAiPrivateEndpointsGenerativeAiPrivateEndpointCollection
    The list of generative_ai_private_endpoint_collection.
    DisplayName string
    A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    Filters []GetGenerativeAiPrivateEndpointsFilter
    Id string
    The OCID of a private endpoint.
    State string
    The current state of the Generative AI Private Endpoint.
    compartmentId String
    generativeAiPrivateEndpointCollections List<GetPrivateEndpointsPrivateEndpointCollection>
    The list of generative_ai_private_endpoint_collection.
    displayName String
    A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    filters List<GetPrivateEndpointsFilter>
    id String
    The OCID of a private endpoint.
    state String
    The current state of the Generative AI Private Endpoint.
    compartmentId string
    generativeAiPrivateEndpointCollections GetGenerativeAiPrivateEndpointsGenerativeAiPrivateEndpointCollection[]
    The list of generative_ai_private_endpoint_collection.
    displayName string
    A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    filters GetGenerativeAiPrivateEndpointsFilter[]
    id string
    The OCID of a private endpoint.
    state string
    The current state of the Generative AI Private Endpoint.
    compartment_id str
    generative_ai_private_endpoint_collections Sequence[GetGenerativeAiPrivateEndpointsGenerativeAiPrivateEndpointCollection]
    The list of generative_ai_private_endpoint_collection.
    display_name str
    A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    filters Sequence[GetGenerativeAiPrivateEndpointsFilter]
    id str
    The OCID of a private endpoint.
    state str
    The current state of the Generative AI Private Endpoint.
    compartmentId String
    generativeAiPrivateEndpointCollections List<Property Map>
    The list of generative_ai_private_endpoint_collection.
    displayName String
    A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    filters List<Property Map>
    id String
    The OCID of a private endpoint.
    state String
    The current state of the Generative AI Private Endpoint.

    Supporting Types

    GetGenerativeAiPrivateEndpointsFilter

    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

    GetGenerativeAiPrivateEndpointsGenerativeAiPrivateEndpointCollection

    GetGenerativeAiPrivateEndpointsGenerativeAiPrivateEndpointCollectionItem

    CompartmentId string
    The OCID of the compartment in which to list resources.
    DefinedTags Dictionary<string, string>
    Description string
    A description of this private endpoint.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    DnsPrefix string
    Fqdn string
    Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.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 the private endpoint.
    LifecycleDetails string
    NsgIds List<string>
    A list of the OCIDs of the network security groups that the private endpoint's VNIC belongs to.
    PreviousState string
    PrivateEndpointIp string
    The private IP address (in the customer's VCN) that represents the access point for the associated endpoint service.
    State string
    The lifecycle state of Generative AI private endpoints.
    SubnetId string
    SystemTags Dictionary<string, string>
    TimeCreated string
    TimeUpdated string
    CompartmentId string
    The OCID of the compartment in which to list resources.
    DefinedTags map[string]string
    Description string
    A description of this private endpoint.
    DisplayName string
    A filter to return only resources that match the given display name exactly.
    DnsPrefix string
    Fqdn string
    Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.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 the private endpoint.
    LifecycleDetails string
    NsgIds []string
    A list of the OCIDs of the network security groups that the private endpoint's VNIC belongs to.
    PreviousState string
    PrivateEndpointIp string
    The private IP address (in the customer's VCN) that represents the access point for the associated endpoint service.
    State string
    The lifecycle state of Generative AI private endpoints.
    SubnetId string
    SystemTags map[string]string
    TimeCreated string
    TimeUpdated string
    compartmentId String
    The OCID of the compartment in which to list resources.
    definedTags Map<String,String>
    description String
    A description of this private endpoint.
    displayName String
    A filter to return only resources that match the given display name exactly.
    dnsPrefix String
    fqdn String
    Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.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 the private endpoint.
    lifecycleDetails String
    nsgIds List<String>
    A list of the OCIDs of the network security groups that the private endpoint's VNIC belongs to.
    previousState String
    privateEndpointIp String
    The private IP address (in the customer's VCN) that represents the access point for the associated endpoint service.
    state String
    The lifecycle state of Generative AI private endpoints.
    subnetId String
    systemTags Map<String,String>
    timeCreated String
    timeUpdated String
    compartmentId string
    The OCID of the compartment in which to list resources.
    definedTags {[key: string]: string}
    description string
    A description of this private endpoint.
    displayName string
    A filter to return only resources that match the given display name exactly.
    dnsPrefix string
    fqdn string
    Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.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 the private endpoint.
    lifecycleDetails string
    nsgIds string[]
    A list of the OCIDs of the network security groups that the private endpoint's VNIC belongs to.
    previousState string
    privateEndpointIp string
    The private IP address (in the customer's VCN) that represents the access point for the associated endpoint service.
    state string
    The lifecycle state of Generative AI private endpoints.
    subnetId string
    systemTags {[key: string]: string}
    timeCreated string
    timeUpdated string
    compartment_id str
    The OCID of the compartment in which to list resources.
    defined_tags Mapping[str, str]
    description str
    A description of this private endpoint.
    display_name str
    A filter to return only resources that match the given display name exactly.
    dns_prefix str
    fqdn str
    Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.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 the private endpoint.
    lifecycle_details str
    nsg_ids Sequence[str]
    A list of the OCIDs of the network security groups that the private endpoint's VNIC belongs to.
    previous_state str
    private_endpoint_ip str
    The private IP address (in the customer's VCN) that represents the access point for the associated endpoint service.
    state str
    The lifecycle state of Generative AI private endpoints.
    subnet_id str
    system_tags Mapping[str, str]
    time_created str
    time_updated str
    compartmentId String
    The OCID of the compartment in which to list resources.
    definedTags Map<String>
    description String
    A description of this private endpoint.
    displayName String
    A filter to return only resources that match the given display name exactly.
    dnsPrefix String
    fqdn String
    Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.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 the private endpoint.
    lifecycleDetails String
    nsgIds List<String>
    A list of the OCIDs of the network security groups that the private endpoint's VNIC belongs to.
    previousState String
    privateEndpointIp String
    The private IP address (in the customer's VCN) that represents the access point for the associated endpoint service.
    state String
    The lifecycle state of Generative AI private endpoints.
    subnetId String
    systemTags Map<String>
    timeCreated String
    timeUpdated String

    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
      Meet Neo: Your AI Platform Teammate