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

oci.GenerativeAi.getGenerativeAiPrivateEndpoint

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

    This data source provides details about a specific Generative Ai Private Endpoint resource in Oracle Cloud Infrastructure Generative AI service.

    Retrieves an Generative AI private endpoint using a privateEndpointId.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testGenerativeAiPrivateEndpoint = oci.GenerativeAi.getGenerativeAiPrivateEndpoint({
        generativeAiPrivateEndpointId: testGenerativeAiPrivateEndpointOciGenerativeAiGenerativeAiPrivateEndpoint.id,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_generative_ai_private_endpoint = oci.GenerativeAi.get_generative_ai_private_endpoint(generative_ai_private_endpoint_id=test_generative_ai_private_endpoint_oci_generative_ai_generative_ai_private_endpoint["id"])
    
    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.GetGenerativeAiPrivateEndpoint(ctx, &generativeai.GetGenerativeAiPrivateEndpointArgs{
    			GenerativeAiPrivateEndpointId: testGenerativeAiPrivateEndpointOciGenerativeAiGenerativeAiPrivateEndpoint.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 testGenerativeAiPrivateEndpoint = Oci.GenerativeAi.GetGenerativeAiPrivateEndpoint.Invoke(new()
        {
            GenerativeAiPrivateEndpointId = testGenerativeAiPrivateEndpointOciGenerativeAiGenerativeAiPrivateEndpoint.Id,
        });
    
    });
    
    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.GetGenerativeAiPrivateEndpointArgs;
    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 testGenerativeAiPrivateEndpoint = GenerativeAiFunctions.getGenerativeAiPrivateEndpoint(GetGenerativeAiPrivateEndpointArgs.builder()
                .generativeAiPrivateEndpointId(testGenerativeAiPrivateEndpointOciGenerativeAiGenerativeAiPrivateEndpoint.id())
                .build());
    
        }
    }
    
    variables:
      testGenerativeAiPrivateEndpoint:
        fn::invoke:
          function: oci:GenerativeAi:getGenerativeAiPrivateEndpoint
          arguments:
            generativeAiPrivateEndpointId: ${testGenerativeAiPrivateEndpointOciGenerativeAiGenerativeAiPrivateEndpoint.id}
    

    Using getGenerativeAiPrivateEndpoint

    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 getGenerativeAiPrivateEndpoint(args: GetGenerativeAiPrivateEndpointArgs, opts?: InvokeOptions): Promise<GetGenerativeAiPrivateEndpointResult>
    function getGenerativeAiPrivateEndpointOutput(args: GetGenerativeAiPrivateEndpointOutputArgs, opts?: InvokeOptions): Output<GetGenerativeAiPrivateEndpointResult>
    def get_generative_ai_private_endpoint(generative_ai_private_endpoint_id: Optional[str] = None,
                                           opts: Optional[InvokeOptions] = None) -> GetGenerativeAiPrivateEndpointResult
    def get_generative_ai_private_endpoint_output(generative_ai_private_endpoint_id: Optional[pulumi.Input[str]] = None,
                                           opts: Optional[InvokeOptions] = None) -> Output[GetGenerativeAiPrivateEndpointResult]
    func LookupGenerativeAiPrivateEndpoint(ctx *Context, args *LookupGenerativeAiPrivateEndpointArgs, opts ...InvokeOption) (*LookupGenerativeAiPrivateEndpointResult, error)
    func LookupGenerativeAiPrivateEndpointOutput(ctx *Context, args *LookupGenerativeAiPrivateEndpointOutputArgs, opts ...InvokeOption) LookupGenerativeAiPrivateEndpointResultOutput

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

    public static class GetGenerativeAiPrivateEndpoint 
    {
        public static Task<GetGenerativeAiPrivateEndpointResult> InvokeAsync(GetGenerativeAiPrivateEndpointArgs args, InvokeOptions? opts = null)
        public static Output<GetGenerativeAiPrivateEndpointResult> Invoke(GetGenerativeAiPrivateEndpointInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetGenerativeAiPrivateEndpointResult> getGenerativeAiPrivateEndpoint(GetGenerativeAiPrivateEndpointArgs args, InvokeOptions options)
    public static Output<GetGenerativeAiPrivateEndpointResult> getGenerativeAiPrivateEndpoint(GetGenerativeAiPrivateEndpointArgs args, InvokeOptions options)
    
    fn::invoke:
      function: oci:GenerativeAi/getGenerativeAiPrivateEndpoint:getGenerativeAiPrivateEndpoint
      arguments:
        # arguments dictionary

    The following arguments are supported:

    GenerativeAiPrivateEndpointId string
    The unique id for a Generative AI private endpoint.
    GenerativeAiPrivateEndpointId string
    The unique id for a Generative AI private endpoint.
    generativeAiPrivateEndpointId String
    The unique id for a Generative AI private endpoint.
    generativeAiPrivateEndpointId string
    The unique id for a Generative AI private endpoint.
    generative_ai_private_endpoint_id str
    The unique id for a Generative AI private endpoint.
    generativeAiPrivateEndpointId String
    The unique id for a Generative AI private endpoint.

    getGenerativeAiPrivateEndpoint Result

    The following output properties are available:

    CompartmentId string
    DefinedTags Dictionary<string, string>
    Description string
    A description of this private endpoint.
    DisplayName string
    A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    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"}
    GenerativeAiPrivateEndpointId string
    Id string
    The OCID of a 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 current state of the Generative AI Private Endpoint.
    SubnetId string
    SystemTags Dictionary<string, string>
    TimeCreated string
    TimeUpdated string
    CompartmentId string
    DefinedTags map[string]string
    Description string
    A description of this private endpoint.
    DisplayName string
    A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    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"}
    GenerativeAiPrivateEndpointId string
    Id string
    The OCID of a 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 current state of the Generative AI Private Endpoint.
    SubnetId string
    SystemTags map[string]string
    TimeCreated string
    TimeUpdated string
    compartmentId String
    definedTags Map<String,String>
    description String
    A description of this private endpoint.
    displayName String
    A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    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"}
    generativeAiPrivateEndpointId String
    id String
    The OCID of a 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 current state of the Generative AI Private Endpoint.
    subnetId String
    systemTags Map<String,String>
    timeCreated String
    timeUpdated String
    compartmentId string
    definedTags {[key: string]: string}
    description string
    A description of this private endpoint.
    displayName string
    A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    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"}
    generativeAiPrivateEndpointId string
    id string
    The OCID of a 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 current state of the Generative AI Private Endpoint.
    subnetId string
    systemTags {[key: string]: string}
    timeCreated string
    timeUpdated string
    compartment_id str
    defined_tags Mapping[str, str]
    description str
    A description of this private endpoint.
    display_name str
    A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    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"}
    generative_ai_private_endpoint_id str
    id str
    The OCID of a 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 current state of the Generative AI Private Endpoint.
    subnet_id str
    system_tags Mapping[str, str]
    time_created str
    time_updated str
    compartmentId String
    definedTags Map<String>
    description String
    A description of this private endpoint.
    displayName String
    A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    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"}
    generativeAiPrivateEndpointId String
    id String
    The OCID of a 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 current state of the Generative AI Private Endpoint.
    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