Oracle Cloud Infrastructure v3.10.0, Nov 5 25

Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

oci.AiLanguage.getEndpoints

Start a Neo task

Explain and create an oci.AiLanguage.getEndpoints resource

Oracle Cloud Infrastructure v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

pulumi/pulumi-oci

Example Usage

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

Example coming soon!

variables:
  testEndpoints:
    fn::invoke:
      function: oci:AiLanguage:getEndpoints
      arguments:
        compartmentId: ${compartmentId}
        displayName: ${endpointDisplayName}
        endpointId: ${testEndpoint.id}
        modelId: ${testModel.id}
        projectId: ${testProject.id}
        state: ${endpointState}

Using getEndpoints

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 getEndpoints(args: GetEndpointsArgs, opts?: InvokeOptions): Promise<GetEndpointsResult>
function getEndpointsOutput(args: GetEndpointsOutputArgs, opts?: InvokeOptions): Output<GetEndpointsResult>

def get_endpoints(compartment_id: Optional[str] = None,
                  display_name: Optional[str] = None,
                  filters: Optional[Sequence[GetEndpointsFilter]] = None,
                  id: Optional[str] = None,
                  model_id: Optional[str] = None,
                  project_id: Optional[str] = None,
                  state: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetEndpointsResult
def get_endpoints_output(compartment_id: Optional[pulumi.Input[str]] = None,
                  display_name: Optional[pulumi.Input[str]] = None,
                  filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetEndpointsFilterArgs]]]] = None,
                  id: Optional[pulumi.Input[str]] = None,
                  model_id: Optional[pulumi.Input[str]] = None,
                  project_id: Optional[pulumi.Input[str]] = None,
                  state: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetEndpointsResult]

func GetEndpoints(ctx *Context, args *GetEndpointsArgs, opts ...InvokeOption) (*GetEndpointsResult, error)
func GetEndpointsOutput(ctx *Context, args *GetEndpointsOutputArgs, opts ...InvokeOption) GetEndpointsResultOutput

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

public static class GetEndpoints 
{
    public static Task<GetEndpointsResult> InvokeAsync(GetEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetEndpointsResult> Invoke(GetEndpointsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetEndpointsResult> getEndpoints(GetEndpointsArgs args, InvokeOptions options)
public static Output<GetEndpointsResult> getEndpoints(GetEndpointsArgs args, InvokeOptions options)

fn::invoke:
  function: oci:AiLanguage/getEndpoints:getEndpoints
  arguments:
    # arguments dictionary

The following arguments are supported:

CompartmentId string: The ID of the compartment in which to list resources.
DisplayName string: A filter to return only resources that match the entire display name given.
Filters List<GetEndpointsFilter>
Id string: Unique identifier endpoint OCID of an endpoint that is immutable on creation.
ModelId string: The ID of the trained model for which to list the endpoints.
ProjectId string: The ID of the project for which to list the objects.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

CompartmentId string: The ID of the compartment in which to list resources.
DisplayName string: A filter to return only resources that match the entire display name given.
Filters []GetEndpointsFilter
Id string: Unique identifier endpoint OCID of an endpoint that is immutable on creation.
ModelId string: The ID of the trained model for which to list the endpoints.
ProjectId string: The ID of the project for which to list the objects.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

compartmentId String: The ID of the compartment in which to list resources.
displayName String: A filter to return only resources that match the entire display name given.
filters List<GetEndpointsFilter>
id String: Unique identifier endpoint OCID of an endpoint that is immutable on creation.
modelId String: The ID of the trained model for which to list the endpoints.
projectId String: The ID of the project for which to list the objects.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

compartmentId string: The ID of the compartment in which to list resources.
displayName string: A filter to return only resources that match the entire display name given.
filters GetEndpointsFilter[]
id string: Unique identifier endpoint OCID of an endpoint that is immutable on creation.
modelId string: The ID of the trained model for which to list the endpoints.
projectId string: The ID of the project for which to list the objects.
state string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

compartment_id str: The ID of the compartment in which to list resources.
display_name str: A filter to return only resources that match the entire display name given.
filters Sequence[GetEndpointsFilter]
id str: Unique identifier endpoint OCID of an endpoint that is immutable on creation.
model_id str: The ID of the trained model for which to list the endpoints.
project_id str: The ID of the project for which to list the objects.
state str: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

compartmentId String: The ID of the compartment in which to list resources.
displayName String: A filter to return only resources that match the entire display name given.
filters List<Property Map>
id String: Unique identifier endpoint OCID of an endpoint that is immutable on creation.
modelId String: The ID of the trained model for which to list the endpoints.
projectId String: The ID of the project for which to list the objects.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.

getEndpoints Result

The following output properties are available:

CompartmentId string: The OCID for the endpoint compartment.
EndpointCollections List<GetEndpointsEndpointCollection>: The list of endpoint_collection.
DisplayName string: A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
Filters List<GetEndpointsFilter>
Id string: Unique identifier endpoint OCID of an endpoint that is immutable on creation.
ModelId string: The OCID of the model to associate with the endpoint.
ProjectId string: The OCID of the project to associate with the Endpoint.
State string: The state of the endpoint.

CompartmentId string: The OCID for the endpoint compartment.
EndpointCollections []GetEndpointsEndpointCollection: The list of endpoint_collection.
DisplayName string: A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
Filters []GetEndpointsFilter
Id string: Unique identifier endpoint OCID of an endpoint that is immutable on creation.
ModelId string: The OCID of the model to associate with the endpoint.
ProjectId string: The OCID of the project to associate with the Endpoint.
State string: The state of the endpoint.

compartmentId String: The OCID for the endpoint compartment.
endpointCollections List<GetEndpointsEndpointCollection>: The list of endpoint_collection.
displayName String: A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
filters List<GetEndpointsFilter>
id String: Unique identifier endpoint OCID of an endpoint that is immutable on creation.
modelId String: The OCID of the model to associate with the endpoint.
projectId String: The OCID of the project to associate with the Endpoint.
state String: The state of the endpoint.

compartmentId string: The OCID for the endpoint compartment.
endpointCollections GetEndpointsEndpointCollection[]: The list of endpoint_collection.
displayName string: A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
filters GetEndpointsFilter[]
id string: Unique identifier endpoint OCID of an endpoint that is immutable on creation.
modelId string: The OCID of the model to associate with the endpoint.
projectId string: The OCID of the project to associate with the Endpoint.
state string: The state of the endpoint.

compartment_id str: The OCID for the endpoint compartment.
endpoint_collections Sequence[GetEndpointsEndpointCollection]: The list of endpoint_collection.
display_name str: A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
filters Sequence[GetEndpointsFilter]
id str: Unique identifier endpoint OCID of an endpoint that is immutable on creation.
model_id str: The OCID of the model to associate with the endpoint.
project_id str: The OCID of the project to associate with the Endpoint.
state str: The state of the endpoint.

compartmentId String: The OCID for the endpoint compartment.
endpointCollections List<Property Map>: The list of endpoint_collection.
displayName String: A user-friendly display name for the resource. It should be unique and can be modified. Avoid entering confidential information.
filters List<Property Map>
id String: Unique identifier endpoint OCID of an endpoint that is immutable on creation.
modelId String: The OCID of the model to associate with the endpoint.
projectId String: The OCID of the project to associate with the Endpoint.
state String: The state of the endpoint.

Supporting Types

GetEndpointsEndpointCollection

Items List<GetEndpointsEndpointCollectionItem>

Items []GetEndpointsEndpointCollectionItem

items List<GetEndpointsEndpointCollectionItem>

items GetEndpointsEndpointCollectionItem[]

items Sequence[GetEndpointsEndpointCollectionItem]

items List<Property Map>

GetEndpointsEndpointCollectionItem

Alias string: Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
CompartmentId string: The ID of the compartment in which to list resources.
DefinedTags Dictionary<string, string>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string: A short description of the endpoint.
DisplayName string: A filter to return only resources that match the entire display name given.
FreeformTags Dictionary<string, string>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: Unique identifier endpoint OCID of an endpoint that is immutable on creation.
InferenceUnits int: Number of replicas required for this endpoint.
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
ModelId string: The ID of the trained model for which to list the endpoints.
ProjectId string: The ID of the project for which to list the objects.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
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 time the the endpoint was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time the endpoint was updated. An RFC3339 formatted datetime string.

Alias string: Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
CompartmentId string: The ID of the compartment in which to list resources.
DefinedTags map[string]string: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
Description string: A short description of the endpoint.
DisplayName string: A filter to return only resources that match the entire display name given.
FreeformTags map[string]string: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
Id string: Unique identifier endpoint OCID of an endpoint that is immutable on creation.
InferenceUnits int: Number of replicas required for this endpoint.
LifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
ModelId string: The ID of the trained model for which to list the endpoints.
ProjectId string: The ID of the project for which to list the objects.
State string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
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 time the the endpoint was created. An RFC3339 formatted datetime string.
TimeUpdated string: The time the endpoint was updated. An RFC3339 formatted datetime string.

alias String: Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
compartmentId String: The ID of the compartment in which to list resources.
definedTags Map<String,String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String: A short description of the endpoint.
displayName String: A filter to return only resources that match the entire display name given.
freeformTags Map<String,String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: Unique identifier endpoint OCID of an endpoint that is immutable on creation.
inferenceUnits Integer: Number of replicas required for this endpoint.
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
modelId String: The ID of the trained model for which to list the endpoints.
projectId String: The ID of the project for which to list the objects.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
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 time the the endpoint was created. An RFC3339 formatted datetime string.
timeUpdated String: The time the endpoint was updated. An RFC3339 formatted datetime string.

alias string: Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
compartmentId string: The ID of the compartment in which to list resources.
definedTags {[key: string]: string}: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description string: A short description of the endpoint.
displayName string: A filter to return only resources that match the entire display name given.
freeformTags {[key: string]: string}: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id string: Unique identifier endpoint OCID of an endpoint that is immutable on creation.
inferenceUnits number: Number of replicas required for this endpoint.
lifecycleDetails string: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
modelId string: The ID of the trained model for which to list the endpoints.
projectId string: The ID of the project for which to list the objects.
state string: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
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 time the the endpoint was created. An RFC3339 formatted datetime string.
timeUpdated string: The time the endpoint was updated. An RFC3339 formatted datetime string.

alias str: Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
compartment_id str: The ID of the compartment in which to list resources.
defined_tags Mapping[str, str]: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description str: A short description of the endpoint.
display_name str: A filter to return only resources that match the entire display name given.
freeform_tags Mapping[str, str]: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id str: Unique identifier endpoint OCID of an endpoint that is immutable on creation.
inference_units int: Number of replicas required for this endpoint.
lifecycle_details str: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
model_id str: The ID of the trained model for which to list the endpoints.
project_id str: The ID of the project for which to list the objects.
state str: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
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 time the the endpoint was created. An RFC3339 formatted datetime string.
time_updated str: The time the endpoint was updated. An RFC3339 formatted datetime string.

alias String: Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.
compartmentId String: The ID of the compartment in which to list resources.
definedTags Map<String>: Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {"foo-namespace.bar-key": "value"}
description String: A short description of the endpoint.
displayName String: A filter to return only resources that match the entire display name given.
freeformTags Map<String>: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"bar-key": "value"}
id String: Unique identifier endpoint OCID of an endpoint that is immutable on creation.
inferenceUnits Number: Number of replicas required for this endpoint.
lifecycleDetails String: A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in failed state.
modelId String: The ID of the trained model for which to list the endpoints.
projectId String: The ID of the project for which to list the objects.
state String: Filter results by the specified lifecycle state. Must be a valid state for the resource type.
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 time the the endpoint was created. An RFC3339 formatted datetime string.
timeUpdated String: The time the endpoint was updated. An RFC3339 formatted datetime string.

GetEndpointsFilter

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 v3.10.0 published on Wednesday, Nov 5, 2025 by Pulumi

pulumi/pulumi-oci

oci.AiLanguage.getEndpoints

On this page

On this page

Example Usage

Using getEndpoints

getEndpoints Result

Supporting Types

GetEndpointsEndpointCollection

GetEndpointsEndpointCollectionItem

GetEndpointsFilter

Package Details

On this page

On this page