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

oci.GenerativeAi.GenerativeAiPrivateEndpoint

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testGenerativeAiPrivateEndpoint = new oci.generativeai.GenerativeAiPrivateEndpoint("test_generative_ai_private_endpoint", {
        compartmentId: compartmentId,
        dnsPrefix: generativeAiPrivateEndpointDnsPrefix,
        subnetId: testSubnet.id,
        definedTags: {
            "Operations.CostCenter": "42",
        },
        description: generativeAiPrivateEndpointDescription,
        displayName: generativeAiPrivateEndpointDisplayName,
        freeformTags: {
            Department: "Finance",
        },
        nsgIds: generativeAiPrivateEndpointNsgIds,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_generative_ai_private_endpoint = oci.generativeai.GenerativeAiPrivateEndpoint("test_generative_ai_private_endpoint",
        compartment_id=compartment_id,
        dns_prefix=generative_ai_private_endpoint_dns_prefix,
        subnet_id=test_subnet["id"],
        defined_tags={
            "Operations.CostCenter": "42",
        },
        description=generative_ai_private_endpoint_description,
        display_name=generative_ai_private_endpoint_display_name,
        freeform_tags={
            "Department": "Finance",
        },
        nsg_ids=generative_ai_private_endpoint_nsg_ids)
    
    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.NewGenerativeAiPrivateEndpoint(ctx, "test_generative_ai_private_endpoint", &generativeai.GenerativeAiPrivateEndpointArgs{
    			CompartmentId: pulumi.Any(compartmentId),
    			DnsPrefix:     pulumi.Any(generativeAiPrivateEndpointDnsPrefix),
    			SubnetId:      pulumi.Any(testSubnet.Id),
    			DefinedTags: pulumi.StringMap{
    				"Operations.CostCenter": pulumi.String("42"),
    			},
    			Description: pulumi.Any(generativeAiPrivateEndpointDescription),
    			DisplayName: pulumi.Any(generativeAiPrivateEndpointDisplayName),
    			FreeformTags: pulumi.StringMap{
    				"Department": pulumi.String("Finance"),
    			},
    			NsgIds: pulumi.Any(generativeAiPrivateEndpointNsgIds),
    		})
    		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 = new Oci.GenerativeAi.GenerativeAiPrivateEndpoint("test_generative_ai_private_endpoint", new()
        {
            CompartmentId = compartmentId,
            DnsPrefix = generativeAiPrivateEndpointDnsPrefix,
            SubnetId = testSubnet.Id,
            DefinedTags = 
            {
                { "Operations.CostCenter", "42" },
            },
            Description = generativeAiPrivateEndpointDescription,
            DisplayName = generativeAiPrivateEndpointDisplayName,
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
            NsgIds = generativeAiPrivateEndpointNsgIds,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.GenerativeAi.GenerativeAiPrivateEndpoint;
    import com.pulumi.oci.GenerativeAi.GenerativeAiPrivateEndpointArgs;
    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) {
            var testGenerativeAiPrivateEndpoint = new GenerativeAiPrivateEndpoint("testGenerativeAiPrivateEndpoint", GenerativeAiPrivateEndpointArgs.builder()
                .compartmentId(compartmentId)
                .dnsPrefix(generativeAiPrivateEndpointDnsPrefix)
                .subnetId(testSubnet.id())
                .definedTags(Map.of("Operations.CostCenter", "42"))
                .description(generativeAiPrivateEndpointDescription)
                .displayName(generativeAiPrivateEndpointDisplayName)
                .freeformTags(Map.of("Department", "Finance"))
                .nsgIds(generativeAiPrivateEndpointNsgIds)
                .build());
    
        }
    }
    
    resources:
      testGenerativeAiPrivateEndpoint:
        type: oci:GenerativeAi:GenerativeAiPrivateEndpoint
        name: test_generative_ai_private_endpoint
        properties:
          compartmentId: ${compartmentId}
          dnsPrefix: ${generativeAiPrivateEndpointDnsPrefix}
          subnetId: ${testSubnet.id}
          definedTags:
            Operations.CostCenter: '42'
          description: ${generativeAiPrivateEndpointDescription}
          displayName: ${generativeAiPrivateEndpointDisplayName}
          freeformTags:
            Department: Finance
          nsgIds: ${generativeAiPrivateEndpointNsgIds}
    

    Create GenerativeAiPrivateEndpoint Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GenerativeAiPrivateEndpoint(name: string, args: GenerativeAiPrivateEndpointArgs, opts?: CustomResourceOptions);
    @overload
    def GenerativeAiPrivateEndpoint(resource_name: str,
                                    args: GenerativeAiPrivateEndpointArgs,
                                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def GenerativeAiPrivateEndpoint(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    compartment_id: Optional[str] = None,
                                    dns_prefix: Optional[str] = None,
                                    subnet_id: Optional[str] = None,
                                    defined_tags: Optional[Mapping[str, str]] = None,
                                    description: Optional[str] = None,
                                    display_name: Optional[str] = None,
                                    freeform_tags: Optional[Mapping[str, str]] = None,
                                    nsg_ids: Optional[Sequence[str]] = None)
    func NewGenerativeAiPrivateEndpoint(ctx *Context, name string, args GenerativeAiPrivateEndpointArgs, opts ...ResourceOption) (*GenerativeAiPrivateEndpoint, error)
    public GenerativeAiPrivateEndpoint(string name, GenerativeAiPrivateEndpointArgs args, CustomResourceOptions? opts = null)
    public GenerativeAiPrivateEndpoint(String name, GenerativeAiPrivateEndpointArgs args)
    public GenerativeAiPrivateEndpoint(String name, GenerativeAiPrivateEndpointArgs args, CustomResourceOptions options)
    
    type: oci:GenerativeAi:GenerativeAiPrivateEndpoint
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args GenerativeAiPrivateEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GenerativeAiPrivateEndpointArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GenerativeAiPrivateEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GenerativeAiPrivateEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GenerativeAiPrivateEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var generativeAiPrivateEndpointResource = new Oci.GenerativeAi.GenerativeAiPrivateEndpoint("generativeAiPrivateEndpointResource", new()
    {
        CompartmentId = "string",
        DnsPrefix = "string",
        SubnetId = "string",
        DefinedTags = 
        {
            { "string", "string" },
        },
        Description = "string",
        DisplayName = "string",
        FreeformTags = 
        {
            { "string", "string" },
        },
        NsgIds = new[]
        {
            "string",
        },
    });
    
    example, err := generativeai.NewGenerativeAiPrivateEndpoint(ctx, "generativeAiPrivateEndpointResource", &generativeai.GenerativeAiPrivateEndpointArgs{
    	CompartmentId: pulumi.String("string"),
    	DnsPrefix:     pulumi.String("string"),
    	SubnetId:      pulumi.String("string"),
    	DefinedTags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Description: pulumi.String("string"),
    	DisplayName: pulumi.String("string"),
    	FreeformTags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	NsgIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var generativeAiPrivateEndpointResource = new GenerativeAiPrivateEndpoint("generativeAiPrivateEndpointResource", GenerativeAiPrivateEndpointArgs.builder()
        .compartmentId("string")
        .dnsPrefix("string")
        .subnetId("string")
        .definedTags(Map.of("string", "string"))
        .description("string")
        .displayName("string")
        .freeformTags(Map.of("string", "string"))
        .nsgIds("string")
        .build());
    
    generative_ai_private_endpoint_resource = oci.generativeai.GenerativeAiPrivateEndpoint("generativeAiPrivateEndpointResource",
        compartment_id="string",
        dns_prefix="string",
        subnet_id="string",
        defined_tags={
            "string": "string",
        },
        description="string",
        display_name="string",
        freeform_tags={
            "string": "string",
        },
        nsg_ids=["string"])
    
    const generativeAiPrivateEndpointResource = new oci.generativeai.GenerativeAiPrivateEndpoint("generativeAiPrivateEndpointResource", {
        compartmentId: "string",
        dnsPrefix: "string",
        subnetId: "string",
        definedTags: {
            string: "string",
        },
        description: "string",
        displayName: "string",
        freeformTags: {
            string: "string",
        },
        nsgIds: ["string"],
    });
    
    type: oci:GenerativeAi:GenerativeAiPrivateEndpoint
    properties:
        compartmentId: string
        definedTags:
            string: string
        description: string
        displayName: string
        dnsPrefix: string
        freeformTags:
            string: string
        nsgIds:
            - string
        subnetId: string
    

    GenerativeAiPrivateEndpoint Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The GenerativeAiPrivateEndpoint resource accepts the following input properties:

    CompartmentId string
    (Updatable) The OCID of the compartment where the private endpoint is created.
    DnsPrefix string
    (Updatable) dnsPrefix of the private endpoint FQDN.
    SubnetId string

    The OCID of the customer's subnet where the private endpoint VNIC will reside.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags Dictionary<string, string>
    (Updatable) 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
    (Updatable) A description of this private endpoint.
    DisplayName string
    (Updatable) A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    FreeformTags Dictionary<string, string>
    (Updatable) 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"}
    NsgIds List<string>
    (Updatable) A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to.
    CompartmentId string
    (Updatable) The OCID of the compartment where the private endpoint is created.
    DnsPrefix string
    (Updatable) dnsPrefix of the private endpoint FQDN.
    SubnetId string

    The OCID of the customer's subnet where the private endpoint VNIC will reside.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags map[string]string
    (Updatable) 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
    (Updatable) A description of this private endpoint.
    DisplayName string
    (Updatable) A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    FreeformTags map[string]string
    (Updatable) 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"}
    NsgIds []string
    (Updatable) A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to.
    compartmentId String
    (Updatable) The OCID of the compartment where the private endpoint is created.
    dnsPrefix String
    (Updatable) dnsPrefix of the private endpoint FQDN.
    subnetId String

    The OCID of the customer's subnet where the private endpoint VNIC will reside.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<String,String>
    (Updatable) 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
    (Updatable) A description of this private endpoint.
    displayName String
    (Updatable) A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    freeformTags Map<String,String>
    (Updatable) 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"}
    nsgIds List<String>
    (Updatable) A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to.
    compartmentId string
    (Updatable) The OCID of the compartment where the private endpoint is created.
    dnsPrefix string
    (Updatable) dnsPrefix of the private endpoint FQDN.
    subnetId string

    The OCID of the customer's subnet where the private endpoint VNIC will reside.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags {[key: string]: string}
    (Updatable) 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
    (Updatable) A description of this private endpoint.
    displayName string
    (Updatable) A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    freeformTags {[key: string]: string}
    (Updatable) 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"}
    nsgIds string[]
    (Updatable) A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to.
    compartment_id str
    (Updatable) The OCID of the compartment where the private endpoint is created.
    dns_prefix str
    (Updatable) dnsPrefix of the private endpoint FQDN.
    subnet_id str

    The OCID of the customer's subnet where the private endpoint VNIC will reside.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    defined_tags Mapping[str, str]
    (Updatable) 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
    (Updatable) A description of this private endpoint.
    display_name str
    (Updatable) A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    freeform_tags Mapping[str, str]
    (Updatable) 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"}
    nsg_ids Sequence[str]
    (Updatable) A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to.
    compartmentId String
    (Updatable) The OCID of the compartment where the private endpoint is created.
    dnsPrefix String
    (Updatable) dnsPrefix of the private endpoint FQDN.
    subnetId String

    The OCID of the customer's subnet where the private endpoint VNIC will reside.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<String>
    (Updatable) 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
    (Updatable) A description of this private endpoint.
    displayName String
    (Updatable) A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    freeformTags Map<String>
    (Updatable) 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"}
    nsgIds List<String>
    (Updatable) A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GenerativeAiPrivateEndpoint resource produces the following output properties:

    Fqdn string
    Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.com)
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    The detailed messages about the lifecycle state
    PreviousState string
    Generative AI private endpoint.
    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.
    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time that the Generative AI 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 Generative AI private endpoint was updated expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    Fqdn string
    Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.com)
    Id string
    The provider-assigned unique ID for this managed resource.
    LifecycleDetails string
    The detailed messages about the lifecycle state
    PreviousState string
    Generative AI private endpoint.
    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.
    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time that the Generative AI 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 Generative AI private endpoint was updated expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    fqdn String
    Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.com)
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    The detailed messages about the lifecycle state
    previousState String
    Generative AI private endpoint.
    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.
    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time that the Generative AI 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 Generative AI private endpoint was updated expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    fqdn string
    Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.com)
    id string
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails string
    The detailed messages about the lifecycle state
    previousState string
    Generative AI private endpoint.
    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.
    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time that the Generative AI 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 Generative AI private endpoint was updated expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    fqdn str
    Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.com)
    id str
    The provider-assigned unique ID for this managed resource.
    lifecycle_details str
    The detailed messages about the lifecycle state
    previous_state str
    Generative AI private endpoint.
    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.
    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time that the Generative AI 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 Generative AI private endpoint was updated expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    fqdn String
    Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.com)
    id String
    The provider-assigned unique ID for this managed resource.
    lifecycleDetails String
    The detailed messages about the lifecycle state
    previousState String
    Generative AI private endpoint.
    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.
    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time that the Generative AI 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 Generative AI private endpoint was updated expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

    Look up Existing GenerativeAiPrivateEndpoint Resource

    Get an existing GenerativeAiPrivateEndpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: GenerativeAiPrivateEndpointState, opts?: CustomResourceOptions): GenerativeAiPrivateEndpoint
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, str]] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            dns_prefix: Optional[str] = None,
            fqdn: Optional[str] = None,
            freeform_tags: Optional[Mapping[str, str]] = None,
            lifecycle_details: Optional[str] = None,
            nsg_ids: Optional[Sequence[str]] = None,
            previous_state: Optional[str] = None,
            private_endpoint_ip: Optional[str] = None,
            state: Optional[str] = None,
            subnet_id: Optional[str] = None,
            system_tags: Optional[Mapping[str, str]] = None,
            time_created: Optional[str] = None,
            time_updated: Optional[str] = None) -> GenerativeAiPrivateEndpoint
    func GetGenerativeAiPrivateEndpoint(ctx *Context, name string, id IDInput, state *GenerativeAiPrivateEndpointState, opts ...ResourceOption) (*GenerativeAiPrivateEndpoint, error)
    public static GenerativeAiPrivateEndpoint Get(string name, Input<string> id, GenerativeAiPrivateEndpointState? state, CustomResourceOptions? opts = null)
    public static GenerativeAiPrivateEndpoint get(String name, Output<String> id, GenerativeAiPrivateEndpointState state, CustomResourceOptions options)
    resources:  _:    type: oci:GenerativeAi:GenerativeAiPrivateEndpoint    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CompartmentId string
    (Updatable) The OCID of the compartment where the private endpoint is created.
    DefinedTags Dictionary<string, string>
    (Updatable) 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
    (Updatable) A description of this private endpoint.
    DisplayName string
    (Updatable) A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    DnsPrefix string
    (Updatable) dnsPrefix of the private endpoint FQDN.
    Fqdn string
    Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.com)
    FreeformTags Dictionary<string, string>
    (Updatable) 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"}
    LifecycleDetails string
    The detailed messages about the lifecycle state
    NsgIds List<string>
    (Updatable) A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to.
    PreviousState string
    Generative AI private endpoint.
    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

    The OCID of the customer's subnet where the private endpoint VNIC will reside.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    SystemTags Dictionary<string, string>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time that the Generative AI 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 Generative AI private endpoint was updated expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    CompartmentId string
    (Updatable) The OCID of the compartment where the private endpoint is created.
    DefinedTags map[string]string
    (Updatable) 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
    (Updatable) A description of this private endpoint.
    DisplayName string
    (Updatable) A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    DnsPrefix string
    (Updatable) dnsPrefix of the private endpoint FQDN.
    Fqdn string
    Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.com)
    FreeformTags map[string]string
    (Updatable) 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"}
    LifecycleDetails string
    The detailed messages about the lifecycle state
    NsgIds []string
    (Updatable) A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to.
    PreviousState string
    Generative AI private endpoint.
    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

    The OCID of the customer's subnet where the private endpoint VNIC will reside.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    SystemTags map[string]string
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    TimeCreated string
    The date and time that the Generative AI 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 Generative AI private endpoint was updated expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    compartmentId String
    (Updatable) The OCID of the compartment where the private endpoint is created.
    definedTags Map<String,String>
    (Updatable) 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
    (Updatable) A description of this private endpoint.
    displayName String
    (Updatable) A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    dnsPrefix String
    (Updatable) dnsPrefix of the private endpoint FQDN.
    fqdn String
    Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.com)
    freeformTags Map<String,String>
    (Updatable) 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"}
    lifecycleDetails String
    The detailed messages about the lifecycle state
    nsgIds List<String>
    (Updatable) A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to.
    previousState String
    Generative AI private endpoint.
    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

    The OCID of the customer's subnet where the private endpoint VNIC will reside.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    systemTags Map<String,String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time that the Generative AI 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 Generative AI private endpoint was updated expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    compartmentId string
    (Updatable) The OCID of the compartment where the private endpoint is created.
    definedTags {[key: string]: string}
    (Updatable) 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
    (Updatable) A description of this private endpoint.
    displayName string
    (Updatable) A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    dnsPrefix string
    (Updatable) dnsPrefix of the private endpoint FQDN.
    fqdn string
    Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.com)
    freeformTags {[key: string]: string}
    (Updatable) 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"}
    lifecycleDetails string
    The detailed messages about the lifecycle state
    nsgIds string[]
    (Updatable) A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to.
    previousState string
    Generative AI private endpoint.
    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

    The OCID of the customer's subnet where the private endpoint VNIC will reside.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    systemTags {[key: string]: string}
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated string
    The date and time that the Generative AI 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 Generative AI private endpoint was updated expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    compartment_id str
    (Updatable) The OCID of the compartment where the private endpoint is created.
    defined_tags Mapping[str, str]
    (Updatable) 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
    (Updatable) A description of this private endpoint.
    display_name str
    (Updatable) A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    dns_prefix str
    (Updatable) dnsPrefix of the private endpoint FQDN.
    fqdn str
    Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.com)
    freeform_tags Mapping[str, str]
    (Updatable) 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"}
    lifecycle_details str
    The detailed messages about the lifecycle state
    nsg_ids Sequence[str]
    (Updatable) A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to.
    previous_state str
    Generative AI private endpoint.
    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

    The OCID of the customer's subnet where the private endpoint VNIC will reside.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    system_tags Mapping[str, str]
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    time_created str
    The date and time that the Generative AI 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 Generative AI private endpoint was updated expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z
    compartmentId String
    (Updatable) The OCID of the compartment where the private endpoint is created.
    definedTags Map<String>
    (Updatable) 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
    (Updatable) A description of this private endpoint.
    displayName String
    (Updatable) A user friendly name. It doesn't have to be unique. Avoid entering confidential information.
    dnsPrefix String
    (Updatable) dnsPrefix of the private endpoint FQDN.
    fqdn String
    Fully qualified domain name the customer will use for access (for eg: xyz.oraclecloud.com)
    freeformTags Map<String>
    (Updatable) 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"}
    lifecycleDetails String
    The detailed messages about the lifecycle state
    nsgIds List<String>
    (Updatable) A list of the OCIDs of the network security groups (NSGs) to add the private endpoint's VNIC to.
    previousState String
    Generative AI private endpoint.
    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

    The OCID of the customer's subnet where the private endpoint VNIC will reside.

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    systemTags Map<String>
    System tags for this resource. Each key is predefined and scoped to a namespace. Example: {"orcl-cloud.free-tier-retained": "true"}
    timeCreated String
    The date and time that the Generative AI 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 Generative AI private endpoint was updated expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

    Import

    GenerativeAiPrivateEndpoints can be imported using the id, e.g.

    $ pulumi import oci:GenerativeAi/generativeAiPrivateEndpoint:GenerativeAiPrivateEndpoint test_generative_ai_private_endpoint "id"
    

    To learn more about importing existing cloud resources, see Importing resources.

    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